lib/stream.h

   1 /*
   2  * Copyright (c) 2009 Nicira Networks.
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at:
   7  *
   8  *     http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16
  17 #ifndef STREAM_H
  18 #define STREAM_H 1
  19
  20 #include <assert.h>
  21 #include <stdbool.h>
  22 #include <stddef.h>
  23 #include <stdint.h>
  24
  25 #include "flow.h"
  26
  27 struct pstream;
  28 struct stream;
  29
  30 void stream_usage(const char *name, bool active, bool passive);
  31
  32 /* Bidirectional byte streams. */
  33 int stream_open(const char *name, struct stream **);
  34 int stream_open_block(const char *name, struct stream **);
  35 void stream_close(struct stream *);
  36 const char *stream_get_name(const struct stream *);
  37 uint32_t stream_get_remote_ip(const struct stream *);
  38 uint16_t stream_get_remote_port(const struct stream *);
  39 uint32_t stream_get_local_ip(const struct stream *);
  40 uint16_t stream_get_local_port(const struct stream *);
  41 int stream_connect(struct stream *);
  42 int stream_recv(struct stream *, void *buffer, size_t n);
  43 int stream_send(struct stream *, const void *buffer, size_t n);
  44
  45 enum stream_wait_type {
  46     STREAM_CONNECT,
  47     STREAM_RECV,
  48     STREAM_SEND
  49 };
  50 void stream_wait(struct stream *, enum stream_wait_type);
  51 void stream_connect_wait(struct stream *);
  52 void stream_recv_wait(struct stream *);
  53 void stream_send_wait(struct stream *);
  54
  55 /* Passive streams: listeners for incoming stream connections. */
  56 int pstream_open(const char *name, struct pstream **);
  57 const char *pstream_get_name(const struct pstream *);
  58 void pstream_close(struct pstream *);
  59 int pstream_accept(struct pstream *, struct stream **);
  60 int pstream_accept_block(struct pstream *, struct stream **);
  61 void pstream_wait(struct pstream *);
  62
  63 #endif /* stream.h */