debian: Synchronize debian/changelog with downstream Debian changelog.
[openvswitch] / lib / stream.h
1 /*
2  * Copyright (c) 2009, 2010, 2011 Nicira, Inc.
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 <sys/types.h>
24 #include "openvswitch/types.h"
25 #include "vlog.h"
26 #include "socket-util.h"
27
28 struct pstream;
29 struct stream;
30
31 void stream_usage(const char *name, bool active, bool passive, bool bootstrap);
32
33 /* Bidirectional byte streams. */
34 int stream_verify_name(const char *name);
35 int stream_open(const char *name, struct stream **, uint8_t dscp);
36 int stream_open_block(int error, struct stream **);
37 void stream_close(struct stream *);
38 const char *stream_get_name(const struct stream *);
39 ovs_be32 stream_get_remote_ip(const struct stream *);
40 ovs_be16 stream_get_remote_port(const struct stream *);
41 ovs_be32 stream_get_local_ip(const struct stream *);
42 ovs_be16 stream_get_local_port(const struct stream *);
43 int stream_connect(struct stream *);
44 int stream_recv(struct stream *, void *buffer, size_t n);
45 int stream_send(struct stream *, const void *buffer, size_t n);
46
47 void stream_run(struct stream *);
48 void stream_run_wait(struct stream *);
49
50 enum stream_wait_type {
51     STREAM_CONNECT,
52     STREAM_RECV,
53     STREAM_SEND
54 };
55 void stream_wait(struct stream *, enum stream_wait_type);
56 void stream_connect_wait(struct stream *);
57 void stream_recv_wait(struct stream *);
58 void stream_send_wait(struct stream *);
59
60 /* Passive streams: listeners for incoming stream connections. */
61 int pstream_verify_name(const char *name);
62 int pstream_open(const char *name, struct pstream **, uint8_t dscp);
63 const char *pstream_get_name(const struct pstream *);
64 void pstream_close(struct pstream *);
65 int pstream_accept(struct pstream *, struct stream **);
66 int pstream_accept_block(struct pstream *, struct stream **);
67 void pstream_wait(struct pstream *);
68 \f
69 /* Convenience functions. */
70
71 int stream_open_with_default_ports(const char *name,
72                                    uint16_t default_tcp_port,
73                                    uint16_t default_ssl_port,
74                                    struct stream **,
75                                    uint8_t dscp);
76 int pstream_open_with_default_ports(const char *name,
77                                     uint16_t default_ptcp_port,
78                                     uint16_t default_pssl_port,
79                                     struct pstream **,
80                                     uint8_t dscp);
81 bool stream_parse_target_with_default_ports(const char *target,
82                                            uint16_t default_tcp_port,
83                                            uint16_t default_ssl_port,
84                                            struct sockaddr_in *sin);
85 int stream_or_pstream_needs_probes(const char *name);
86
87 /* Error reporting. */
88
89 enum stream_content_type {
90     STREAM_UNKNOWN,
91     STREAM_OPENFLOW,
92     STREAM_SSL,
93     STREAM_JSONRPC
94 };
95
96 void stream_report_content(const void *, ssize_t, enum stream_content_type,
97                            struct vlog_module *, const char *stream_name);
98
99 #endif /* stream.h */