7#include <osmocom/core/msgb.h>
12#define OSMO_STREAM_SCTP_MSG_FLAGS_NOTIFICATION 0x80
13#define msgb_sctp_msg_flags(msg) (msg)->cb[2]
16#define msgb_sctp_ppid(msg) (msg)->cb[3]
18#define msgb_sctp_stream(msg) (msg)->cb[4]
66struct osmo_stream_srv_link;
68typedef int (*osmo_stream_srv_link_accept_cb_t)(
struct osmo_stream_srv_link *link,
int fd);
96enum osmo_stream_srv_link_param {
97 OSMO_STREAM_SRV_LINK_PAR_SCTP_SOCKOPT_AUTH_SUPPORTED,
98 OSMO_STREAM_SRV_LINK_PAR_SCTP_SOCKOPT_ASCONF_SUPPORTED,
99 OSMO_STREAM_SRV_LINK_PAR_SCTP_INIT_NUM_OSTREAMS,
100 OSMO_STREAM_SRV_LINK_PAR_SCTP_INIT_MAX_INSTREAMS,
102 OSMO_STREAM_SRV_LINK_PAR_TCP_SOCKOPT_KEEPALIVE = 256,
103 OSMO_STREAM_SRV_LINK_PAR_TCP_SOCKOPT_KEEPIDLE,
104 OSMO_STREAM_SRV_LINK_PAR_TCP_SOCKOPT_KEEPINTVL,
105 OSMO_STREAM_SRV_LINK_PAR_TCP_SOCKOPT_KEEPCNT,
106 OSMO_STREAM_SRV_LINK_PAR_TCP_SOCKOPT_USER_TIMEOUT,
110 void *val,
size_t val_len);
114struct osmo_stream_srv;
116typedef int (*osmo_stream_srv_read_cb_t)(
struct osmo_stream_srv *conn);
117typedef int (*osmo_stream_srv_closed_cb_t)(
struct osmo_stream_srv *conn);
126typedef int (*osmo_stream_srv_segmentation_cb_t)(
struct msgb *msg);
127typedef int (*osmo_stream_srv_segmentation_cb2_t)(
struct osmo_stream_srv *conn,
struct msgb *msg);
130 osmo_stream_srv_read_cb_t read_cb,
131 osmo_stream_srv_closed_cb_t closed_cb,
133struct osmo_stream_srv *
osmo_stream_srv_create2(
void *ctx,
struct osmo_stream_srv_link *link,
int fd,
void *data);
156void osmo_stream_srv_clear_tx_queue(
struct osmo_stream_srv *conn);
158enum osmo_stream_srv_param {
159 OSMO_STREAM_SRV_PAR_TCP_SOCKOPT_KEEPALIVE = 256,
160 OSMO_STREAM_SRV_PAR_TCP_SOCKOPT_KEEPIDLE,
161 OSMO_STREAM_SRV_PAR_TCP_SOCKOPT_KEEPINTVL,
162 OSMO_STREAM_SRV_PAR_TCP_SOCKOPT_KEEPCNT,
163 OSMO_STREAM_SRV_PAR_TCP_SOCKOPT_USER_TIMEOUT,
166 void *val,
size_t val_len);
206struct osmo_stream_cli;
208typedef int (*osmo_stream_cli_connect_cb_t)(
struct osmo_stream_cli *cli);
209typedef int (*osmo_stream_cli_disconnect_cb_t)(
struct osmo_stream_cli *cli);
210typedef int (*osmo_stream_cli_read_cb_t)(
struct osmo_stream_cli *cli);
219typedef int (*osmo_stream_cli_segmentation_cb_t)(
struct msgb *msg);
220typedef int (*osmo_stream_cli_segmentation_cb2_t)(
struct osmo_stream_cli *cli,
struct msgb *msg);
259 OSMO_DEPRECATED(
"Use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead");
267enum osmo_stream_cli_param {
268 OSMO_STREAM_CLI_PAR_SCTP_SOCKOPT_AUTH_SUPPORTED,
269 OSMO_STREAM_CLI_PAR_SCTP_SOCKOPT_ASCONF_SUPPORTED,
270 OSMO_STREAM_CLI_PAR_SCTP_INIT_NUM_OSTREAMS,
271 OSMO_STREAM_CLI_PAR_SCTP_INIT_MAX_INSTREAMS,
272 OSMO_STREAM_CLI_PAR_SCTP_INIT_MAX_ATTEMPTS,
273 OSMO_STREAM_CLI_PAR_SCTP_INIT_TIMEOUT,
275 OSMO_STREAM_CLI_PAR_TCP_SOCKOPT_KEEPALIVE = 256,
276 OSMO_STREAM_CLI_PAR_TCP_SOCKOPT_KEEPIDLE,
277 OSMO_STREAM_CLI_PAR_TCP_SOCKOPT_KEEPINTVL,
278 OSMO_STREAM_CLI_PAR_TCP_SOCKOPT_KEEPCNT,
279 OSMO_STREAM_CLI_PAR_TCP_SOCKOPT_USER_TIMEOUT,
283 void *val,
size_t val_len);
void osmo_stream_cli_set_addr(struct osmo_stream_cli *cli, const char *addr)
Set the remote address to which we connect.
Definition: stream_cli.c:713
struct osmo_fd * osmo_stream_cli_get_ofd(struct osmo_stream_cli *cli)
Retrieve Osmocom File Descriptor of the stream client socket.
Definition: stream_cli.c:985
int osmo_stream_cli_set_param(struct osmo_stream_cli *cli, enum osmo_stream_cli_param par, void *val, size_t val_len)
Set given parameter of stream client to given value.
Definition: stream_cli.c:1497
int osmo_stream_cli_recv(struct osmo_stream_cli *cli, struct msgb *msg)
Receive data via an Osmocom stream client in osmo_fd mode.
Definition: stream_cli.c:1417
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 bind.
Definition: stream_cli.c:786
const char * osmo_stream_cli_get_name(const struct osmo_stream_cli *cli)
Retrieve name previously set on the cli object (see osmo_stream_cli_set_name()).
Definition: stream_cli.c:702
int(* osmo_stream_cli_read_cb2_t)(struct osmo_stream_cli *cli, int res, struct msgb *msg)
Completion call-back function when something was read from from the stream client socket.
Definition: stream.h:217
void osmo_stream_cli_reconnect(struct osmo_stream_cli *cli)
Re-connect an Osmocom Stream Client.
Definition: stream_cli.c:254
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!...
Definition: stream_cli.c:1071
struct osmo_stream_cli * osmo_stream_cli_create(void *ctx)
Create an Osmocom stream client.
Definition: stream_cli.c:500
int osmo_stream_cli_set_ip_dscp(struct osmo_stream_cli *cli, uint8_t ip_dscp)
Set the DSCP (differentiated services code point) of the stream socket.
Definition: stream_cli.c:1196
int osmo_stream_cli_set_domain(struct osmo_stream_cli *cli, int domain)
Set the socket domain for the stream client link.
Definition: stream_cli.c:905
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_cli.c:762
int osmo_stream_cli_set_type(struct osmo_stream_cli *cli, int type)
Set the socket type for the stream server link.
Definition: stream_cli.c:885
void osmo_stream_cli_set_data(struct osmo_stream_cli *cli, void *data)
Set application private data of the stream client socket.
Definition: stream_cli.c:934
void * osmo_stream_cli_get_data(struct osmo_stream_cli *cli)
Retrieve application private data of the stream client socket.
Definition: stream_cli.c:942
void osmo_stream_cli_set_disconnect_cb(struct osmo_stream_cli *cli, osmo_stream_cli_disconnect_cb_t disconnect_cb)
Set the call-back function called on disconnect of the stream client socket.
Definition: stream_cli.c:1006
void osmo_stream_cli_set_connect_cb(struct osmo_stream_cli *cli, osmo_stream_cli_connect_cb_t connect_cb)
Set the call-back function called on connect of the stream client socket.
Definition: stream_cli.c:997
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_cli.c:774
void osmo_stream_cli_set_read_cb2(struct osmo_stream_cli *cli, osmo_stream_cli_read_cb2_t read_cb)
Set the call-back function called to read from the stream client socket.
Definition: stream_cli.c:1030
void osmo_stream_cli_set_read_cb(struct osmo_stream_cli *cli, osmo_stream_cli_read_cb_t read_cb)
Set the call-back function called to read from the stream client socket.
Definition: stream_cli.c:1017
bool osmo_stream_cli_is_connected(struct osmo_stream_cli *cli)
Check if Osmocom Stream Client is in connected state.
Definition: stream_cli.c:263
int osmo_stream_cli_open(struct osmo_stream_cli *cli)
Open connection of an Osmocom stream client.
Definition: stream_cli.c:1225
int osmo_stream_cli_set_tx_queue_max_length(struct osmo_stream_cli *cli, unsigned int size)
Set the maximum length queue of the stream client.
Definition: stream_cli.c:953
void osmo_stream_cli_set_proto(struct osmo_stream_cli *cli, uint16_t proto)
Set the protocol for the stream client socket.
Definition: stream_cli.c:811
void osmo_stream_cli_destroy(struct osmo_stream_cli *cli)
Destroy a Osmocom stream client (includes close).
Definition: stream_cli.c:1040
void osmo_stream_cli_set_nodelay(struct osmo_stream_cli *cli, bool nodelay)
Set the NODELAY socket option to avoid Nagle-like behavior.
Definition: stream_cli.c:1136
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.
Definition: stream_cli.c:725
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_cli.c:1360
void osmo_stream_cli_set_segmentation_cb(struct osmo_stream_cli *cli, osmo_stream_cli_segmentation_cb_t segmentation_cb)
Set the segmentation callback for the client.
Definition: stream_cli.c:853
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_cli.c:750
struct osmo_io_fd * osmo_stream_cli_get_iofd(const struct osmo_stream_cli *cli)
Retrieve osmo_io descriptor of the stream client socket.
Definition: stream_cli.c:303
int osmo_stream_cli_set_priority(struct osmo_stream_cli *cli, int sk_prio)
Set the priority value of the stream socket.
Definition: stream_cli.c:1165
void osmo_stream_cli_set_name_f(struct osmo_stream_cli *cli, const char *fmt,...)
Set a name on the cli object using arguments like printf() (used during logging).
Definition: stream_cli.c:678
void osmo_stream_cli_close(struct osmo_stream_cli *cli)
Close an Osmocom Stream Client.
Definition: stream_cli.c:222
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_cli.c:925
void osmo_stream_cli_set_name(struct osmo_stream_cli *cli, const char *name)
Set a name on the cli object (used during logging).
Definition: stream_cli.c:669
char * osmo_stream_cli_get_sockname(const struct osmo_stream_cli *cli)
Retrieve the stream client socket description.
Definition: stream_cli.c:970
void osmo_stream_cli_set_segmentation_cb2(struct osmo_stream_cli *cli, osmo_stream_cli_segmentation_cb2_t segmentation_cb2)
Set the segmentation callback for the client.
Definition: stream_cli.c:870
void osmo_stream_cli_clear_tx_queue(struct osmo_stream_cli *cli)
Clear the transmit queue of the stream client.
Definition: stream_cli.c:1472
int osmo_stream_cli_get_fd(const struct osmo_stream_cli *cli)
Retrieve file descriptor of the stream client socket.
Definition: stream_cli.c:283
int osmo_stream_srv_set_param(struct osmo_stream_srv *conn, enum osmo_stream_srv_param par, void *val, size_t val_len)
Set given parameter of stream_srv to given value.
Definition: stream_srv.c:1461
struct osmo_stream_srv * osmo_stream_srv_create(void *ctx, struct osmo_stream_srv_link *link, int fd, osmo_stream_srv_read_cb_t read_cb, osmo_stream_srv_closed_cb_t closed_cb, void *data)
Create a legacy osmo_fd mode Stream Server inside the specified link.
Definition: stream_srv.c:976
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_srv.c:370
void osmo_stream_srv_set_name(struct osmo_stream_srv *conn, const char *name)
Set a name on the srv object (used during logging).
Definition: stream_srv.c:1070
void osmo_stream_srv_link_set_accept_cb(struct osmo_stream_srv_link *link, osmo_stream_srv_link_accept_cb_t accept_cb)
Set the accept() call-back of the stream server link.
Definition: stream_srv.c:527
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_srv.c:356
bool osmo_stream_srv_link_is_opened(const struct osmo_stream_srv_link *link)
Check whether the stream server link is opened.
Definition: stream_srv.c:621
void osmo_stream_srv_set_segmentation_cb2(struct osmo_stream_srv *conn, osmo_stream_srv_segmentation_cb2_t segmentation_cb2)
Set the segmentation callback for target osmo_stream_srv structure.
Definition: stream_srv.c:1217
int osmo_stream_srv_link_set_priority(struct osmo_stream_srv_link *link, int sk_prio)
Set the priority value of the stream socket.
Definition: stream_srv.c:282
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.
Definition: stream_srv.c:266
struct osmo_fd * osmo_stream_srv_get_ofd(struct osmo_stream_srv *srv)
Retrieve Osmocom File Descriptor of a stream server in osmo_fd mode.
Definition: stream_srv.c:1254
void osmo_stream_srv_destroy(struct osmo_stream_srv *conn)
Destroy given Stream Server.
Definition: stream_srv.c:1302
const char * osmo_stream_srv_get_sockname(const struct osmo_stream_srv *conn)
Retrieve the stream server socket description.
Definition: stream_srv.c:1240
int osmo_stream_srv_link_set_ip_dscp(struct osmo_stream_srv_link *link, uint8_t ip_dscp)
Set the DSCP (differentiated services code point) of the stream socket.
Definition: stream_srv.c:295
void osmo_stream_srv_set_segmentation_cb(struct osmo_stream_srv *conn, osmo_stream_srv_segmentation_cb_t segmentation_cb)
Set the segmentation callback for target osmo_stream_srv structure.
Definition: stream_srv.c:1198
int(* osmo_stream_srv_read_cb2_t)(struct osmo_stream_srv *conn, int res, struct msgb *msg)
Completion call-back function when something was read from from the stream client socket.
Definition: stream.h:124
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_srv.c:410
int osmo_stream_srv_link_open(struct osmo_stream_srv_link *link)
Open the stream server link.
Definition: stream_srv.c:568
const char * osmo_stream_srv_link_get_name(const struct osmo_stream_srv_link *link)
Retrieve name previously set on the srv_link object (see osmo_stream_srv_link_set_name()).
Definition: stream_srv.c:254
int osmo_stream_srv_link_set_param(struct osmo_stream_srv_link *link, enum osmo_stream_srv_link_param par, void *val, size_t val_len)
Set given parameter of stream_srv_link to given value.
Definition: stream_srv.c:651
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_srv.c:343
void osmo_stream_srv_set_name_f(struct osmo_stream_srv *conn, const char *fmt,...)
Set a name on the srv object using arguments like printf() (used during logging).
Definition: stream_srv.c:1079
struct osmo_fd * osmo_stream_srv_link_get_ofd(struct osmo_stream_srv_link *link)
Retrieve Osmocom File Descriptor of the stream server link.
Definition: stream_srv.c:508
char * osmo_stream_srv_link_get_sockname(const struct osmo_stream_srv_link *link)
Retrieve description of the stream server link e.
Definition: stream_srv.c:495
int osmo_stream_srv_get_fd(const struct osmo_stream_srv *srv)
Retrieve File Descriptor of the stream server.
Definition: stream_srv.c:1264
void osmo_stream_srv_set_flush_and_destroy(struct osmo_stream_srv *conn)
Prepare to send out all pending messages on the connection's Tx queue.
Definition: stream_srv.c:1142
void osmo_stream_srv_link_destroy(struct osmo_stream_srv_link *link)
Destroy the stream server link.
Definition: stream_srv.c:556
struct osmo_stream_srv * osmo_stream_srv_create2(void *ctx, struct osmo_stream_srv_link *link, int fd, void *data)
Create an osmo_iofd mode Stream Server inside the specified link.
Definition: stream_srv.c:1022
int osmo_stream_srv_link_set_msgb_alloc_info(struct osmo_stream_srv_link *link, unsigned int size, unsigned int headroom)
Set the msgb allocation parameters on child osmo_stream_srv objects.
Definition: stream_srv.c:542
int osmo_stream_srv_link_set_domain(struct osmo_stream_srv_link *link, int domain)
Set the socket domain for the stream server link.
Definition: stream_srv.c:390
void osmo_stream_srv_set_data(struct osmo_stream_srv *conn, void *data)
Set application private data of the stream server.
Definition: stream_srv.c:1151
struct osmo_stream_srv_link * osmo_stream_srv_get_master(struct osmo_stream_srv *conn)
Retrieve the master (Link) from a Stream Server.
Definition: stream_srv.c:1292
struct osmo_io_fd * osmo_stream_srv_get_iofd(const struct osmo_stream_srv *srv)
Retrieve osmo_io descriptor of the stream server socket.
Definition: stream_srv.c:1283
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_srv.c:1330
struct osmo_stream_srv_link * osmo_stream_srv_link_create(void *ctx)
Create an Osmocom Stream Server Link.
Definition: stream_srv.c:221
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.
Definition: stream_srv.c:319
int osmo_stream_srv_recv(struct osmo_stream_srv *conn, struct msgb *msg)
Receive data via an Osmocom stream server in osmo_fd mode.
Definition: stream_srv.c:1384
void * osmo_stream_srv_link_get_data(struct osmo_stream_srv_link *link)
Retrieve application private data of the stream server link.
Definition: stream_srv.c:419
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_srv.c:306
void osmo_stream_srv_set_read_cb(struct osmo_stream_srv *conn, osmo_stream_srv_read_cb2_t read_cb)
Set the call-back function for incoming data on an osmo_io stream_srv.
Definition: stream_srv.c:1117
void osmo_stream_srv_link_close(struct osmo_stream_srv_link *link)
Close the stream server link and unregister from select loop.
Definition: stream_srv.c:635
const char * osmo_stream_srv_get_name(const struct osmo_stream_srv *conn)
Retrieve name previously set on the srv object (see osmo_stream_srv_set_name()).
Definition: stream_srv.c:1103
int osmo_stream_srv_link_set_tx_queue_max_length(struct osmo_stream_srv_link *link, unsigned int size)
Set the maximum length queue of the stream servers accepted and allocated from this server link.
Definition: stream_srv.c:430
void osmo_stream_srv_link_set_name(struct osmo_stream_srv_link *link, const char *name)
Set a name on the srv_link object (used during logging).
Definition: stream_srv.c:245
void * osmo_stream_srv_get_data(struct osmo_stream_srv *conn)
Retrieve application private data of the stream server.
Definition: stream_srv.c:1231
int osmo_stream_srv_link_get_fd(const struct osmo_stream_srv_link *link)
Retrieve File Descriptor of the stream server link.
Definition: stream_srv.c:516
void osmo_stream_srv_set_closed_cb(struct osmo_stream_srv *conn, osmo_stream_srv_closed_cb_t close_cb)
Set the call-back function called when the stream server socket was closed.
Definition: stream_srv.c:1130