lib/stream.h

   1 /*
   2  * Copyright (c) 2009, 2010 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 <stdbool.h>
  21 #include <stddef.h>
  22 #include <stdint.h>
  23 #include "vlog.h"
  24
  25 struct pstream;
  26 struct stream;
  27
  28 void stream_usage(const char *name, bool active, bool passive, bool bootstrap);
  29
  30 /* Bidirectional byte streams. */
  31 int stream_verify_name(const char *name);
  32 int stream_open(const char *name, struct stream **);
  33 int stream_open_block(int error, struct stream **);
  34 void stream_close(struct stream *);
  35 const char *stream_get_name(const struct stream *);
  36 uint32_t stream_get_remote_ip(const struct stream *);
  37 uint16_t stream_get_remote_port(const struct stream *);
  38 uint32_t stream_get_local_ip(const struct stream *);
  39 uint16_t stream_get_local_port(const struct stream *);
  40 int stream_connect(struct stream *);
  41 int stream_recv(struct stream *, void *buffer, size_t n);
  42 int stream_send(struct stream *, const void *buffer, size_t n);
  43
  44 void stream_run(struct stream *);
  45 void stream_run_wait(struct stream *);
  46
  47 enum stream_wait_type {
  48     STREAM_CONNECT,
  49     STREAM_RECV,
  50     STREAM_SEND
  51 };
  52 void stream_wait(struct stream *, enum stream_wait_type);
  53 void stream_connect_wait(struct stream *);
  54 void stream_recv_wait(struct stream *);
  55 void stream_send_wait(struct stream *);
  56
  57 /* Passive streams: listeners for incoming stream connections. */
  58 int pstream_verify_name(const char *name);
  59 int pstream_open(const char *name, struct pstream **);
  60 const char *pstream_get_name(const struct pstream *);
  61 void pstream_close(struct pstream *);
  62 int pstream_accept(struct pstream *, struct stream **);
  63 int pstream_accept_block(struct pstream *, struct stream **);
  64 void pstream_wait(struct pstream *);
  65 \f
  66 /* Convenience functions. */
  67
  68 int stream_open_with_default_ports(const char *name,
  69                                    uint16_t default_tcp_port,
  70                                    uint16_t default_ssl_port,
  71                                    struct stream **);
  72 int pstream_open_with_default_ports(const char *name,
  73                                     uint16_t default_ptcp_port,
  74                                     uint16_t default_pssl_port,
  75                                     struct pstream **);
  76 \f
  77 /* Error reporting. */
  78
  79 enum stream_content_type {
  80     STREAM_UNKNOWN,
  81     STREAM_OPENFLOW,
  82     STREAM_SSL,
  83     STREAM_JSONRPC
  84 };
  85
  86 void stream_report_content(const void *, size_t, enum stream_content_type,
  87                            struct vlog_module *, const char *stream_name);
  88
  89 #endif /* stream.h */