libosmo-netif  1.2.0.67-9ee4
Osmocom network interface library
stream.h
1 #pragma once
2 
3 #include <stdbool.h>
4 #include <stdint.h>
5 
6 #include <osmocom/core/msgb.h>
7 
13 #define OSMO_STREAM_SCTP_MSG_FLAGS_NOTIFICATION 0x80 /* sctp_recvmsg() flags=MSG_NOTIFICATION, msgb_data() contains "union sctp_notification*" */
14 #define msgb_sctp_msg_flags(msg) (msg)->cb[2]
15 
17 #define msgb_sctp_ppid(msg) (msg)->cb[3]
18 
19 #define msgb_sctp_stream(msg) (msg)->cb[4]
20 
22 struct osmo_stream_srv_link;
23 
24 struct osmo_stream_srv_link *osmo_stream_srv_link_create(void *ctx);
25 void osmo_stream_srv_link_destroy(struct osmo_stream_srv_link *link);
26 
27 void osmo_stream_srv_link_set_nodelay(struct osmo_stream_srv_link *link, bool nodelay);
28 void osmo_stream_srv_link_set_addr(struct osmo_stream_srv_link *link, const char *addr);
29 int osmo_stream_srv_link_set_addrs(struct osmo_stream_srv_link *link, const char **addr, size_t addrcnt);
30 void osmo_stream_srv_link_set_port(struct osmo_stream_srv_link *link, uint16_t port);
31 void osmo_stream_srv_link_set_proto(struct osmo_stream_srv_link *link, uint16_t proto);
32 int osmo_stream_srv_link_set_type(struct osmo_stream_srv_link *link, int type);
33 int osmo_stream_srv_link_set_domain(struct osmo_stream_srv_link *link, int domain);
34 void osmo_stream_srv_link_set_accept_cb(struct osmo_stream_srv_link *link, int (*accept_cb)(struct osmo_stream_srv_link *link, int fd));
35 void osmo_stream_srv_link_set_data(struct osmo_stream_srv_link *link, void *data);
36 void *osmo_stream_srv_link_get_data(struct osmo_stream_srv_link *link);
37 char *osmo_stream_srv_link_get_sockname(const struct osmo_stream_srv_link *link);
38 struct osmo_fd *osmo_stream_srv_link_get_ofd(struct osmo_stream_srv_link *link);
39 
40 int osmo_stream_srv_link_open(struct osmo_stream_srv_link *link);
41 void osmo_stream_srv_link_close(struct osmo_stream_srv_link *link);
42 
45 struct osmo_stream_srv;
46 
47 struct osmo_stream_srv *osmo_stream_srv_create(void *ctx, struct osmo_stream_srv_link *link, int fd, int (*cb)(struct osmo_stream_srv *conn), int (*closed_cb)(struct osmo_stream_srv *conn), void *data);
48 void *osmo_stream_srv_get_data(struct osmo_stream_srv *conn);
49 struct osmo_stream_srv_link *osmo_stream_srv_get_master(struct osmo_stream_srv *conn);
50 struct osmo_fd *osmo_stream_srv_get_ofd(struct osmo_stream_srv *srv);
51 void osmo_stream_srv_destroy(struct osmo_stream_srv *conn);
52 
53 void osmo_stream_srv_set_flush_and_destroy(struct osmo_stream_srv *conn);
54 void osmo_stream_srv_set_data(struct osmo_stream_srv *conn, void *data);
55 
56 void osmo_stream_srv_send(struct osmo_stream_srv *conn, struct msgb *msg);
57 int osmo_stream_srv_recv(struct osmo_stream_srv *conn, struct msgb *msg);
58 
59 void osmo_stream_srv_clear_tx_queue(struct osmo_stream_srv *conn);
60 
62 struct osmo_stream_cli;
63 
64 void osmo_stream_cli_set_nodelay(struct osmo_stream_cli *cli, bool nodelay);
65 void osmo_stream_cli_set_addr(struct osmo_stream_cli *cli, const char *addr);
66 int osmo_stream_cli_set_addrs(struct osmo_stream_cli *cli, const char **addr, size_t addrcnt);
67 void osmo_stream_cli_set_port(struct osmo_stream_cli *cli, uint16_t port);
68 int osmo_stream_cli_set_type(struct osmo_stream_cli *cli, int type);
69 int osmo_stream_cli_set_domain(struct osmo_stream_cli *cli, int domain);
70 void osmo_stream_cli_set_proto(struct osmo_stream_cli *cli, uint16_t proto);
71 void osmo_stream_cli_set_local_addr(struct osmo_stream_cli *cli, const char *addr);
72 int osmo_stream_cli_set_local_addrs(struct osmo_stream_cli *cli, const char **addr, size_t addrcnt);
73 void osmo_stream_cli_set_local_port(struct osmo_stream_cli *cli, uint16_t port);
74 void osmo_stream_cli_set_data(struct osmo_stream_cli *cli, void *data);
75 void osmo_stream_cli_set_reconnect_timeout(struct osmo_stream_cli *cli, int timeout);
76 void *osmo_stream_cli_get_data(struct osmo_stream_cli *cli);
77 char *osmo_stream_cli_get_sockname(const struct osmo_stream_cli *cli);
78 struct osmo_fd *osmo_stream_cli_get_ofd(struct osmo_stream_cli *cli);
79 void osmo_stream_cli_set_connect_cb(struct osmo_stream_cli *cli, int (*connect_cb)(struct osmo_stream_cli *cli));
80 void osmo_stream_cli_set_disconnect_cb(struct osmo_stream_cli *cli, int (*disconnect_cb)(struct osmo_stream_cli *cli));
81 void osmo_stream_cli_set_read_cb(struct osmo_stream_cli *cli, int (*read_cb)(struct osmo_stream_cli *cli));
82 void osmo_stream_cli_reconnect(struct osmo_stream_cli *cli);
83 bool osmo_stream_cli_is_connected(struct osmo_stream_cli *cli);
84 
85 struct osmo_stream_cli *osmo_stream_cli_create(void *ctx);
86 void osmo_stream_cli_destroy(struct osmo_stream_cli *cli);
87 
88 int osmo_stream_cli_open(struct osmo_stream_cli *cli);
89 int osmo_stream_cli_open2(struct osmo_stream_cli *cli, int reconnect) \
90  OSMO_DEPRECATED("Use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead");
91 void osmo_stream_cli_close(struct osmo_stream_cli *cli);
92 
93 void osmo_stream_cli_send(struct osmo_stream_cli *cli, struct msgb *msg);
94 int osmo_stream_cli_recv(struct osmo_stream_cli *cli, struct msgb *msg);
95 
96 void osmo_stream_cli_clear_tx_queue(struct osmo_stream_cli *cli);
97 
osmo_stream_srv_link_set_addrs
int osmo_stream_srv_link_set_addrs(struct osmo_stream_srv_link *link, const char **addr, size_t addrcnt)
Set the local address set to which we bind. Useful for protocols allowing bind on more than one addre...
Definition: stream.c:1058
osmo_stream_cli
Definition: stream.c:250
osmo_stream_cli_set_read_cb
void osmo_stream_cli_set_read_cb(struct osmo_stream_cli *cli, int(*read_cb)(struct osmo_stream_cli *cli))
Set the call-back function called to read from the stream client socket.
Definition: stream.c:706
osmo_stream_cli_get_sockname
char * osmo_stream_cli_get_sockname(const struct osmo_stream_cli *cli)
Get the stream client socket description.
Definition: stream.c:665
osmo_stream_cli_set_type
int osmo_stream_cli_set_type(struct osmo_stream_cli *cli, int type)
Set the socket type for the stream server link.
Definition: stream.c:601
osmo_stream_cli_set_addrs
int osmo_stream_cli_set_addrs(struct osmo_stream_cli *cli, const char **addr, size_t addrcnt)
Set the remote address set to which we connect. Useful for protocols allowing connecting to more than...
Definition: stream.c:509
osmo_stream_cli_set_domain
int osmo_stream_cli_set_domain(struct osmo_stream_cli *cli, int domain)
Set the socket type for the stream server link.
Definition: stream.c:620
osmo_stream_srv_link_get_data
void * osmo_stream_srv_link_get_data(struct osmo_stream_srv_link *link)
Get application private data of the stream server link.
Definition: stream.c:1154
osmo_stream_cli_close
void osmo_stream_cli_close(struct osmo_stream_cli *cli)
Close an Osmocom Stream Client.
Definition: stream.c:307
osmo_stream_cli_set_local_addrs
int osmo_stream_cli_set_local_addrs(struct osmo_stream_cli *cli, const char **addr, size_t addrcnt)
Set the local address set to which we connect. Useful for protocols allowing bind to more than one ad...
Definition: stream.c:566
osmo_stream_cli_set_port
void osmo_stream_cli_set_port(struct osmo_stream_cli *cli, uint16_t port)
Set the remote port number to which we connect.
Definition: stream.c:533
osmo_stream_srv_link_open
int osmo_stream_srv_link_open(struct osmo_stream_srv_link *link)
Open the stream server link. This actually initializes the underlying socket and binds it to the conf...
Definition: stream.c:1209
osmo_stream_srv
Definition: stream.c:1272
osmo_stream_cli_set_local_addr
void osmo_stream_cli_set_local_addr(struct osmo_stream_cli *cli, const char *addr)
Set the local address for the socket (to be bound to)
Definition: stream.c:555
osmo_stream_cli_set_nodelay
void osmo_stream_cli_set_nodelay(struct osmo_stream_cli *cli, bool nodelay)
Set the NODELAY socket option to avoid Nagle-like behavior Setting this to nodelay=true will automati...
Definition: stream.c:787
osmo_stream_srv_link_get_sockname
char * osmo_stream_srv_link_get_sockname(const struct osmo_stream_srv_link *link)
Get description of the stream server link e. g. 127.0.0.1:1234.
Definition: stream.c:1162
osmo_stream_cli_set_reconnect_timeout
void osmo_stream_cli_set_reconnect_timeout(struct osmo_stream_cli *cli, int timeout)
Set the reconnect time of the stream client socket.
Definition: stream.c:640
osmo_stream_srv_destroy
void osmo_stream_srv_destroy(struct osmo_stream_srv *conn)
Destroy given Stream Server This function closes the Stream Server socket, unregisters from select lo...
Definition: stream.c:1452
osmo_stream_cli_get_data
void * osmo_stream_cli_get_data(struct osmo_stream_cli *cli)
Get application private data of the stream client socket.
Definition: stream.c:657
osmo_stream_srv_link_close
void osmo_stream_srv_link_close(struct osmo_stream_srv_link *link)
Close the stream server link and unregister from select loop Does not destroy the server link...
Definition: stream.c:1261
osmo_stream_cli_set_disconnect_cb
void osmo_stream_cli_set_disconnect_cb(struct osmo_stream_cli *cli, int(*disconnect_cb)(struct osmo_stream_cli *cli))
Set the call-back function called on disconnect of the stream client socket.
Definition: stream.c:696
osmo_stream_srv_create
struct osmo_stream_srv * osmo_stream_srv_create(void *ctx, struct osmo_stream_srv_link *link, int fd, int(*cb)(struct osmo_stream_srv *conn), int(*closed_cb)(struct osmo_stream_srv *conn), void *data)
Create a Stream Server inside the specified link.
Definition: stream.c:1373
osmo_stream_srv_link_get_ofd
struct osmo_fd * osmo_stream_srv_link_get_ofd(struct osmo_stream_srv_link *link)
Get Osmocom File Descriptor of the stream server link.
Definition: stream.c:1182
osmo_stream_srv_link_set_data
void osmo_stream_srv_link_set_data(struct osmo_stream_srv_link *link, void *data)
Set application private data of the stream server link.
Definition: stream.c:1145
osmo_stream_srv_link_set_proto
void osmo_stream_srv_link_set_proto(struct osmo_stream_srv_link *link, uint16_t proto)
Set the protocol for the stream server link.
Definition: stream.c:1093
osmo_stream_srv_get_data
void * osmo_stream_srv_get_data(struct osmo_stream_srv *conn)
Get application private data of the stream server.
Definition: stream.c:1424
osmo_stream_cli_send
void osmo_stream_cli_send(struct osmo_stream_cli *cli, struct msgb *msg)
Enqueue data to be sent via an Osmocom stream client.
Definition: stream.c:873
osmo_stream_srv_link_destroy
void osmo_stream_srv_link_destroy(struct osmo_stream_srv_link *link)
Destroy the stream server link. Closes + Releases Memory.
Definition: stream.c:1199
osmo_stream_cli_get_ofd
struct osmo_fd * osmo_stream_cli_get_ofd(struct osmo_stream_cli *cli)
Get Osmocom File Descriptor of the stream client socket.
Definition: stream.c:678
osmo_stream_cli_reconnect
void osmo_stream_cli_reconnect(struct osmo_stream_cli *cli)
Re-connect an Osmocom Stream Client If re-connection is enabled for this client (which is the case un...
Definition: stream.c:279
osmo_stream_cli_set_addr
void osmo_stream_cli_set_addr(struct osmo_stream_cli *cli, const char *addr)
Set the remote address to which we connect.
Definition: stream.c:498
osmo_stream_srv_set_data
void osmo_stream_srv_set_data(struct osmo_stream_srv *conn, void *data)
Set application private data of the stream server.
Definition: stream.c:1415
osmo_stream_cli_create
struct osmo_stream_cli * osmo_stream_cli_create(void *ctx)
Create an Osmocom stream client.
Definition: stream.c:470
osmo_stream_srv_link_set_domain
int osmo_stream_srv_link_set_domain(struct osmo_stream_srv_link *link, int domain)
Set the socket type for the stream server link.
Definition: stream.c:1125
osmo_stream_srv_link_set_type
int osmo_stream_srv_link_set_type(struct osmo_stream_srv_link *link, int type)
Set the socket type for the stream server link.
Definition: stream.c:1106
osmo_stream_cli_is_connected
bool osmo_stream_cli_is_connected(struct osmo_stream_cli *cli)
Check if Osmocom Stream Client is in connected state.
Definition: stream.c:298
osmo_stream_srv_link_set_nodelay
void osmo_stream_srv_link_set_nodelay(struct osmo_stream_srv_link *link, bool nodelay)
Set the NODELAY socket option to avoid Nagle-like behavior Setting this to nodelay=true will automati...
Definition: stream.c:1034
osmo_stream_srv_send
void osmo_stream_srv_send(struct osmo_stream_srv *conn, struct msgb *msg)
Enqueue data to be sent via an Osmocom stream server.
Definition: stream.c:1466
osmo_stream_cli_destroy
void osmo_stream_cli_destroy(struct osmo_stream_cli *cli)
Destroy a Osmocom stream client (includes close)
Definition: stream.c:714
osmo_stream_cli_open2
int osmo_stream_cli_open2(struct osmo_stream_cli *cli, int reconnect) OSMO_DEPRECATED("Use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead")
DEPRECATED: use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead! Open ...
Definition: stream.c:728
osmo_stream_srv_get_master
struct osmo_stream_srv_link * osmo_stream_srv_get_master(struct osmo_stream_srv *conn)
Get the master (Link) from a Stream Server.
Definition: stream.c:1441
osmo_stream_cli_set_connect_cb
void osmo_stream_cli_set_connect_cb(struct osmo_stream_cli *cli, int(*connect_cb)(struct osmo_stream_cli *cli))
Set the call-back function called on connect of the stream client socket.
Definition: stream.c:687
osmo_stream_srv_set_flush_and_destroy
void osmo_stream_srv_set_flush_and_destroy(struct osmo_stream_srv *conn)
Prepare to send out all pending messages on the connection&#39;s Tx queue and then automatically destroy ...
Definition: stream.c:1406
osmo_stream_srv_get_ofd
struct osmo_fd * osmo_stream_srv_get_ofd(struct osmo_stream_srv *srv)
Get Osmocom File Descriptor of the stream server.
Definition: stream.c:1433
osmo_stream_srv_link_set_accept_cb
void osmo_stream_srv_link_set_accept_cb(struct osmo_stream_srv_link *link, int(*accept_cb)(struct osmo_stream_srv_link *link, int fd))
Set the accept() call-back of the stream server link.
Definition: stream.c:1190
osmo_stream_cli_open
int osmo_stream_cli_open(struct osmo_stream_cli *cli)
Open connection of an Osmocom stream client By default the client will automatically reconnect after ...
Definition: stream.c:800
osmo_stream_cli_recv
int osmo_stream_cli_recv(struct osmo_stream_cli *cli, struct msgb *msg)
Receive data via an Osmocom stream client.
Definition: stream.c:885
osmo_stream_srv_link_set_addr
void osmo_stream_srv_link_set_addr(struct osmo_stream_srv_link *link, const char *addr)
Set the local address to which we bind.
Definition: stream.c:1046
osmo_stream_srv_recv
int osmo_stream_srv_recv(struct osmo_stream_srv *conn, struct msgb *msg)
Receive data via Osmocom stream server.
Definition: stream.c:1559
osmo_stream_cli_set_local_port
void osmo_stream_cli_set_local_port(struct osmo_stream_cli *cli, uint16_t port)
Set the local port number for the socket (to be bound to)
Definition: stream.c:544
osmo_stream_srv_link_set_port
void osmo_stream_srv_link_set_port(struct osmo_stream_srv_link *link, uint16_t port)
Set the local port number to which we bind.
Definition: stream.c:1081
osmo_stream_srv_link
Definition: stream.c:924
osmo_stream_cli_set_data
void osmo_stream_cli_set_data(struct osmo_stream_cli *cli, void *data)
Set application private data of the stream client socket.
Definition: stream.c:649
osmo_stream_cli_set_proto
void osmo_stream_cli_set_proto(struct osmo_stream_cli *cli, uint16_t proto)
Set the protocol for the stream client socket.
Definition: stream.c:590
osmo_stream_srv_link_create
struct osmo_stream_srv_link * osmo_stream_srv_link_create(void *ctx)
Create an Osmocom Stream Server Link A Stream Server Link is the listen()+accept() "parent" to indivi...
Definition: stream.c:1011