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