- Generated on Sat Nov 30 2024 00:55:43 for libosmo-netif by
1.9.4
|
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom multiplex protocol helpers (output) More...
#include <stdio.h>#include <string.h>#include <osmocom/core/msgb.h>#include <osmocom/core/timer.h>#include <osmocom/core/timer_compat.h>#include <osmocom/core/select.h>#include <osmocom/core/talloc.h>#include <osmocom/core/logging.h>#include <osmocom/netif/amr.h>#include <osmocom/netif/rtp.h>#include <osmocom/netif/osmux.h>#include <arpa/inet.h>Macros | |
| #define | DELTA_RTP_MSG 20000 |
| #define | DELTA_RTP_TIMESTAMP 160 |
Functions | |
| struct osmux_hdr * | osmux_xfrm_output_pull (struct msgb *msg) |
| int | osmux_xfrm_output_sched (struct osmux_out_handle *h, struct osmux_hdr *osmuxh) |
| Generate RTP packets from osmux frame AMR payload set and schedule them for transmission at appropriate time. More... | |
| void | osmux_xfrm_output_flush (struct osmux_out_handle *h) |
| Flush all scheduled RTP packets still pending to be transmitted. More... | |
| struct osmux_out_handle * | osmux_xfrm_output_alloc (void *ctx) |
| Allocate a new osmux out handle. More... | |
| void | osmux_xfrm_output_init2 (struct osmux_out_handle *h, uint32_t rtp_ssrc, uint8_t rtp_payload_type) OSMO_DEPRECATED("Use osmux_xfrm_output_alloc() and osmux_xfrm_output_set_rtp_*() instead") |
| void | osmux_xfrm_output_init (struct osmux_out_handle *h, uint32_t rtp_ssrc) OSMO_DEPRECATED("Use osmux_xfrm_output_alloc() and osmux_xfrm_output_set_rtp_*() instead") |
| void | osmux_xfrm_output_set_tx_cb (struct osmux_out_handle *h, void(*tx_cb)(struct msgb *msg, void *data), void *data) |
| Set transmission callback to call when a generated RTP packet is to be transmitted. More... | |
| void | osmux_xfrm_output_set_rtp_msgb_alloc_cb (struct osmux_out_handle *h, rtp_msgb_alloc_cb_t cb, void *cb_data) |
| Set callback to call when an RTP packet to be generated is to be allocated. More... | |
| void | osmux_xfrm_output_set_rtp_ssrc (struct osmux_out_handle *h, uint32_t rtp_ssrc) |
| Set SSRC of generated RTP packets from Osmux frames. More... | |
| void | osmux_xfrm_output_set_rtp_pl_type (struct osmux_out_handle *h, uint32_t rtp_payload_type) |
| Set Payload Type of generated RTP packets from Osmux frames. More... | |
Osmocom multiplex protocol helpers (output)
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
one per OSmux circuit_id, ie. More...
#include <osmux.h>
one per OSmux circuit_id, ie.
one per RTP flow.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom Jitter Buffer helpers. More...
#include <stdint.h>#include <stdbool.h>#include <time.h>#include <osmocom/core/timer.h>Go to the source code of this file.
Data Structures | |
| struct | osmo_jibuf |
| A structure representing a single instance of a jitter buffer. More... | |
Typedefs | |
| typedef void(* | osmo_jibuf_dequeue_cb) (struct msgb *msg, void *data) |
Functions | |
| struct osmo_jibuf * | osmo_jibuf_alloc (void *talloc_ctx) |
| Allocate a new jitter buffer instance. More... | |
| void | osmo_jibuf_delete (struct osmo_jibuf *jb) |
| Destroy a previously allocated jitter buffer instance. More... | |
| int | osmo_jibuf_enqueue (struct osmo_jibuf *jb, struct msgb *msg) |
| Try to enqueue a packet into the jitter buffer. More... | |
| bool | osmo_jibuf_empty (struct osmo_jibuf *jb) |
| Check whether the jitter buffer instance has packets queued or not. More... | |
| void | osmo_jibuf_set_min_delay (struct osmo_jibuf *jb, uint32_t min_delay) |
| Set minimum buffer size for the jitter buffer. More... | |
| void | osmo_jibuf_set_max_delay (struct osmo_jibuf *jb, uint32_t max_delay) |
| Set maximum buffer size for the jitter buffer. More... | |
| void | osmo_jibuf_enable_skew_compensation (struct osmo_jibuf *jb, bool enable) |
| Toggle use of skew detection and compensation mechanism. More... | |
| void | osmo_jibuf_set_dequeue_cb (struct osmo_jibuf *jb, osmo_jibuf_dequeue_cb dequeue_cb, void *cb_data) |
| Set dequeue callback for the jitter buffer. More... | |
Osmocom Jitter Buffer helpers.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
A structure representing a single instance of a jitter buffer. More...
#include <jibuf.h>
A structure representing a single instance of a jitter buffer.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
#include <stdio.h>#include <unistd.h>#include <stdlib.h>#include <errno.h>#include <string.h>#include <time.h>#include <sys/fcntl.h>#include <sys/socket.h>#include <sys/un.h>#include <sys/ioctl.h>#include <arpa/inet.h>#include <netinet/in.h>#include <netinet/tcp.h>#include <osmocom/core/timer.h>#include <osmocom/core/select.h>#include <osmocom/core/utils.h>#include <osmocom/gsm/tlv.h>#include <osmocom/core/msgb.h>#include <osmocom/core/osmo_io.h>#include <osmocom/core/panic.h>#include <osmocom/core/logging.h>#include <osmocom/core/talloc.h>#include <osmocom/core/socket.h>#include <osmocom/netif/stream.h>#include <osmocom/netif/stream_private.h>#include "config.h"#include <osmocom/netif/sctp.h>Macros | |
| #define | LOGSLNK(link, level, fmt, args...) |
| #define | LOGSSRV(srv, level, fmt, args...) |
| #define | OSMO_STREAM_SRV_F_RECONF (1 << 0) |
| #define | OSMO_STREAM_SRV_F_NODELAY (1 << 1) |
| #define | OSMO_STREAM_SRV_F_FLUSH_DESTROY (1 << 0) |
Functions | |
| struct osmo_stream_srv_link * | osmo_stream_srv_link_create (void *ctx) |
| Create an Osmocom Stream Server Link. More... | |
| 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). More... | |
| 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()). More... | |
| 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. More... | |
| int | osmo_stream_srv_link_set_priority (struct osmo_stream_srv_link *link, int sk_prio) |
| Set the priority value of the stream socket. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_addr (struct osmo_stream_srv_link *link, const char *addr) |
| Set the local address to which we bind. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_proto (struct osmo_stream_srv_link *link, uint16_t proto) |
| Set the protocol for the stream server link. More... | |
| int | osmo_stream_srv_link_set_type (struct osmo_stream_srv_link *link, int type) |
| Set the socket type for the stream server link. More... | |
| int | osmo_stream_srv_link_set_domain (struct osmo_stream_srv_link *link, int domain) |
| Set the socket type for the stream server link. More... | |
| void | osmo_stream_srv_link_set_data (struct osmo_stream_srv_link *link, void *data) |
| Set application private data of the stream server link. More... | |
| void * | osmo_stream_srv_link_get_data (struct osmo_stream_srv_link *link) |
| Retrieve application private data of the stream server link. More... | |
| 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. More... | |
| char * | osmo_stream_srv_link_get_sockname (const struct osmo_stream_srv_link *link) |
| Retrieve description of the stream server link e. More... | |
| struct osmo_fd * | osmo_stream_srv_link_get_ofd (struct osmo_stream_srv_link *link) |
| Retrieve Osmocom File Descriptor of the stream server link. More... | |
| int | osmo_stream_srv_link_get_fd (const struct osmo_stream_srv_link *link) |
| Retrieve File Descriptor of the stream server link. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_destroy (struct osmo_stream_srv_link *link) |
| Destroy the stream server link. More... | |
| int | osmo_stream_srv_link_open (struct osmo_stream_srv_link *link) |
| Open the stream server link. More... | |
| bool | osmo_stream_srv_link_is_opened (const struct osmo_stream_srv_link *link) |
| Check whether the stream server link is opened. More... | |
| void | osmo_stream_srv_link_close (struct osmo_stream_srv_link *link) |
| Close the stream server link and unregister from select loop. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_srv_set_name (struct osmo_stream_srv *conn, const char *name) |
| Set a name on the srv object (used during logging). More... | |
| 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()). More... | |
| 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. More... | |
| void | osmo_stream_srv_set_closed_cb (struct osmo_stream_srv *conn, osmo_stream_srv_closed_cb_t closed_cb) |
| Set the call-back function called when the stream server socket was closed. More... | |
| 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. More... | |
| void | osmo_stream_srv_set_data (struct osmo_stream_srv *conn, void *data) |
| Set application private data of the stream server. More... | |
| 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. More... | |
| void * | osmo_stream_srv_get_data (struct osmo_stream_srv *conn) |
| Retrieve application private data of the stream server. More... | |
| const char * | osmo_stream_srv_get_sockname (const struct osmo_stream_srv *conn) |
| Retrieve the stream server socket description. More... | |
| struct osmo_fd * | osmo_stream_srv_get_ofd (struct osmo_stream_srv *conn) |
| Retrieve Osmocom File Descriptor of a stream server in osmo_fd mode. More... | |
| int | osmo_stream_srv_get_fd (const struct osmo_stream_srv *conn) |
| Retrieve File Descriptor of the stream server. More... | |
| struct osmo_io_fd * | osmo_stream_srv_get_iofd (const struct osmo_stream_srv *srv) |
| Retrieve osmo_io descriptor of the stream server socket. More... | |
| struct osmo_stream_srv_link * | osmo_stream_srv_get_master (struct osmo_stream_srv *conn) |
| Retrieve the master (Link) from a Stream Server. More... | |
| void | osmo_stream_srv_destroy (struct osmo_stream_srv *conn) |
| Destroy given Stream Server. More... | |
| void | osmo_stream_srv_send (struct osmo_stream_srv *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom stream server. More... | |
| int | osmo_stream_srv_recv (struct osmo_stream_srv *conn, struct msgb *msg) |
| Receive data via an Osmocom stream server in osmo_fd mode. More... | |
| void | osmo_stream_srv_clear_tx_queue (struct osmo_stream_srv *conn) |
| #define LOGSLNK | ( | link, | |
| level, | |||
| fmt, | |||
| args... | |||
| ) |
| #define LOGSSRV | ( | srv, | |
| level, | |||
| fmt, | |||
| args... | |||
| ) |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint8_t | data [0] |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 
'+
''+
''+
''+
'
'
''
'|
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 
');
}
function showSyncOn(n,relpath)
{
n.html('
');
}
function toggleSyncButton(relpath)
{
var navSync = $('#nav-sync');
if (navSync.hasClass('sync')) {
navSync.removeClass('sync');
showSyncOff(navSync,relpath);
storeLink(stripPath2(pathName())+hashUrl());
} else {
navSync.addClass('sync');
showSyncOn(navSync,relpath);
deleteLink();
}
}
var loadTriggered = false;
var readyTriggered = false;
var loadObject,loadToRoot,loadUrl,loadRelPath;
$(window).on('load',function(){
if (readyTriggered) { // ready first
navTo(loadObject,loadToRoot,loadUrl,loadRelPath);
showRoot();
}
loadTriggered=true;
});
function initNavTree(toroot,relpath)
{
var o = new Object();
o.toroot = toroot;
o.node = new Object();
o.node.li = document.getElementById("nav-tree-contents");
o.node.childrenData = NAVTREE;
o.node.children = new Array();
o.node.childrenUL = document.createElement("ul");
o.node.getChildrenUL = function() { return o.node.childrenUL; };
o.node.li.appendChild(o.node.childrenUL);
o.node.depth = 0;
o.node.relpath = relpath;
o.node.expanded = false;
o.node.isLast = true;
o.node.plus_img = document.createElement("span");
o.node.plus_img.className = 'arrow';
o.node.plus_img.innerHTML = arrowRight;
if (localStorageSupported()) {
var navSync = $('#nav-sync');
if (cachedLink()) {
showSyncOff(navSync,relpath);
navSync.removeClass('sync');
} else {
showSyncOn(navSync,relpath);
}
navSync.click(function(){ toggleSyncButton(relpath); });
}
if (loadTriggered) { // load before ready
navTo(o,toroot,hashUrl(),relpath);
showRoot();
} else { // ready before load
loadObject = o;
loadToRoot = toroot;
loadUrl = hashUrl();
loadRelPath = relpath;
readyTriggered=true;
}
$(window).bind('hashchange', function(){
if (window.location.hash && window.location.hash.length>1){
var a;
if ($(location).attr('hash')){
var clslink=stripPath(pathName())+':'+hashValue();
a=$('.item a[class$="'+clslink.replace(/
|
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Files | |
| file | jibuf.h |
| Osmocom Jitter Buffer helpers. | |
Data Structures | |
| struct | osmo_jibuf |
| A structure representing a single instance of a jitter buffer. More... | |
Typedefs | |
| typedef void(* | osmo_jibuf_dequeue_cb) (struct msgb *msg, void *data) |
Functions | |
| struct osmo_jibuf * | osmo_jibuf_alloc (void *talloc_ctx) |
| Allocate a new jitter buffer instance. More... | |
| void | osmo_jibuf_delete (struct osmo_jibuf *jb) |
| Destroy a previously allocated jitter buffer instance. More... | |
| int | osmo_jibuf_enqueue (struct osmo_jibuf *jb, struct msgb *msg) |
| Try to enqueue a packet into the jitter buffer. More... | |
| bool | osmo_jibuf_empty (struct osmo_jibuf *jb) |
| Check whether the jitter buffer instance has packets queued or not. More... | |
| void | osmo_jibuf_set_min_delay (struct osmo_jibuf *jb, uint32_t min_delay) |
| Set minimum buffer size for the jitter buffer. More... | |
| void | osmo_jibuf_set_max_delay (struct osmo_jibuf *jb, uint32_t max_delay) |
| Set maximum buffer size for the jitter buffer. More... | |
| void | osmo_jibuf_enable_skew_compensation (struct osmo_jibuf *jb, bool enable) |
| Toggle use of skew detection and compensation mechanism. More... | |
| void | osmo_jibuf_set_dequeue_cb (struct osmo_jibuf *jb, osmo_jibuf_dequeue_cb dequeue_cb, void *cb_data) |
| Set dequeue callback for the jitter buffer. More... | |
| struct osmo_jibuf * osmo_jibuf_alloc | ( | void * | talloc_ctx | ) |
Allocate a new jitter buffer instance.
| void osmo_jibuf_delete | ( | struct osmo_jibuf * | jb | ) |
Destroy a previously allocated jitter buffer instance.
| [in] | jb | Previously allocated (non-null) jitter buffer instance |
All the queued packets are dequeued before deleting the instance.
| bool osmo_jibuf_empty | ( | struct osmo_jibuf * | jb | ) |
Check whether the jitter buffer instance has packets queued or not.
| [in] | jb | jitter buffer instance |
| void osmo_jibuf_enable_skew_compensation | ( | struct osmo_jibuf * | jb, |
| bool | enable | ||
| ) |
Toggle use of skew detection and compensation mechanism.
| [in] | jb | jitter buffer instance |
| [in] | enable | Whether to enable or not (default) the skew estimation and compensation mechanism |
When this function is called, the estimated skew is reset.
| int osmo_jibuf_enqueue | ( | struct osmo_jibuf * | jb, |
| struct msgb * | msg | ||
| ) |
Try to enqueue a packet into the jitter buffer.
| [in] | jb | jitter buffer instance |
| [in] | msg | msgb to enqueue, containing an RTP packet |
This function calculates the delay for the enqueued packet. If the delay is bigger than the current buffer size, the function returns -1 and the caller owns the packet again and can free it if required. If the packet is enqueued, 0 is returned and the exact same packet (ownership transfer, no copy is made) will be available again through the dequeue_cb() when the queue timer for this packet expires.
| void osmo_jibuf_set_dequeue_cb | ( | struct osmo_jibuf * | jb, |
| osmo_jibuf_dequeue_cb | dequeue_cb, | ||
| void * | cb_data | ||
| ) |
Set dequeue callback for the jitter buffer.
| [in] | jb | jitter buffer instance |
| [in] | dequeue_cb | function pointer to call back when the dequeue timer for a given packet expires |
| [in] | cb_data | data pointer to be passed to dequeue_cb together with the msgb. |
| void osmo_jibuf_set_max_delay | ( | struct osmo_jibuf * | jb, |
| uint32_t | max_delay | ||
| ) |
Set maximum buffer size for the jitter buffer.
| [in] | jb | jitter buffer instance |
| [in] | max_delay | Maximum buffer size, as in maximum delay in milliseconds |
| void osmo_jibuf_set_min_delay | ( | struct osmo_jibuf * | jb, |
| uint32_t | min_delay | ||
| ) |
Set minimum buffer size for the jitter buffer.
| [in] | jb | jitter buffer instance |
| [in] | min_delay | Minimum buffer size, as in minimum delay in milliseconds |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
This code is intended to abstract any client use of stream-type sockets, such as TCP and SCTP. More...
Typedefs | |
| typedef int(* | osmo_stream_cli_connect_cb_t) (struct osmo_stream_cli *cli) |
| typedef int(* | osmo_stream_cli_disconnect_cb_t) (struct osmo_stream_cli *cli) |
| typedef int(* | osmo_stream_cli_read_cb_t) (struct osmo_stream_cli *cli) |
| typedef 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. More... | |
| typedef int(* | osmo_stream_cli_segmentation_cb_t) (struct msgb *msg) |
Functions | |
| void | osmo_stream_cli_set_name (struct osmo_stream_cli *cli, const char *name) |
| Set a name on the cli object (used during logging). More... | |
| 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()). More... | |
| void | osmo_stream_cli_set_nodelay (struct osmo_stream_cli *cli, bool nodelay) |
| Set the NODELAY socket option to avoid Nagle-like behavior. More... | |
| int | osmo_stream_cli_set_priority (struct osmo_stream_cli *cli, int sk_prio) |
| Set the priority value of the stream socket. More... | |
| 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. More... | |
| void | osmo_stream_cli_set_addr (struct osmo_stream_cli *cli, const char *addr) |
| Set the remote address to which we connect. More... | |
| 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. More... | |
| void | osmo_stream_cli_set_port (struct osmo_stream_cli *cli, uint16_t port) |
| Set the remote port number to which we connect. More... | |
| int | osmo_stream_cli_set_type (struct osmo_stream_cli *cli, int type) |
| Set the socket type for the stream server link. More... | |
| int | osmo_stream_cli_set_domain (struct osmo_stream_cli *cli, int domain) |
| Set the socket type for the stream server link. More... | |
| void | osmo_stream_cli_set_proto (struct osmo_stream_cli *cli, uint16_t proto) |
| Set the protocol for the stream client socket. More... | |
| 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). More... | |
| 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. More... | |
| 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). More... | |
| void | osmo_stream_cli_set_data (struct osmo_stream_cli *cli, void *data) |
| Set application private data of the stream client socket. More... | |
| void | osmo_stream_cli_set_reconnect_timeout (struct osmo_stream_cli *cli, int timeout) |
| Set the reconnect time of the stream client socket. More... | |
| void * | osmo_stream_cli_get_data (struct osmo_stream_cli *cli) |
| Retrieve application private data of the stream client socket. More... | |
| 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. More... | |
| char * | osmo_stream_cli_get_sockname (const struct osmo_stream_cli *cli) |
| Retrieve the stream client socket description. More... | |
| struct osmo_fd * | osmo_stream_cli_get_ofd (struct osmo_stream_cli *cli) |
| Retrieve Osmocom File Descriptor of the stream client socket. More... | |
| int | osmo_stream_cli_get_fd (const struct osmo_stream_cli *cli) |
| Retrieve file descriptor of the stream client socket. More... | |
| struct osmo_io_fd * | osmo_stream_cli_get_iofd (const struct osmo_stream_cli *cli) |
| Retrieve osmo_io descriptor of the stream client socket. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_cli_reconnect (struct osmo_stream_cli *cli) |
| Re-connect an Osmocom Stream Client. More... | |
| bool | osmo_stream_cli_is_connected (struct osmo_stream_cli *cli) |
| Check if Osmocom Stream Client is in connected state. More... | |
| struct osmo_stream_cli * | osmo_stream_cli_create (void *ctx) |
| Create an Osmocom stream client. More... | |
| void | osmo_stream_cli_destroy (struct osmo_stream_cli *cli) |
| Destroy a Osmocom stream client (includes close). More... | |
| int | osmo_stream_cli_open (struct osmo_stream_cli *cli) |
| Open connection of an Osmocom stream client. More... | |
| int | osmo_stream_cli_open2 (struct osmo_stream_cli *cli, int reconnect) |
| DEPRECATED: use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead! Open connection of an Osmocom stream client. More... | |
| void | osmo_stream_cli_close (struct osmo_stream_cli *cli) |
| Close an Osmocom Stream Client. More... | |
| void | osmo_stream_cli_send (struct osmo_stream_cli *cli, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom stream client. More... | |
| int | osmo_stream_cli_recv (struct osmo_stream_cli *cli, struct msgb *msg) |
| Receive data via an Osmocom stream client in osmo_fd mode. More... | |
| void | osmo_stream_cli_clear_tx_queue (struct osmo_stream_cli *cli) |
| Clear the transmit queue of the stream client. More... | |
| 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. More... | |
This code is intended to abstract any client use of stream-type sockets, such as TCP and SCTP.
An osmo_stream_cli represents a client implementation of a SOCK_STREAM or SOCK_SEQPACKET socket. It contains all the common logic like non-blocking outbound connect to a remote server, re-connecting after disconnect or connect failure, etc.
osmo_stream_cli can operate in two different modes:
For any new applications, you definitely should use the modern mode, as it provides you with a higher layer of abstraction and allows you to perform efficient I/O using the io_uring backend of osmo_io.
A typical usage of osmo_stream_cli would look as follows:
Once the connection is established, your connect_cb is called to notify you.
You may send data to the connection using osmo_tream_cli_send().
Any received inbound data on the connection is reported vie the read_cb.
| typedef 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.
| [in] | cli | Stream Client that got receive event. |
| [in] | res | return value of the read()/recvmsg()/... call, or -errno in case of error. |
| [in] | msg | message buffer containing the read data. Ownership is transferred to the call-back, and it must make sure to msgb_free() it eventually! |
| void osmo_stream_cli_clear_tx_queue | ( | struct osmo_stream_cli * | cli | ) |
Clear the transmit queue of the stream client.
Calling this function wil clear (delete) any pending, not-yet transmitted data from the transmit queue.
| void osmo_stream_cli_close | ( | struct osmo_stream_cli * | cli | ) |
Close an Osmocom Stream Client.
| [in] | cli | Osmocom Stream Client to be closed We unregister the socket fd from the osmocom select() loop abstraction and close the socket |
| struct osmo_stream_cli * osmo_stream_cli_create | ( | void * | ctx | ) |
Create an Osmocom stream client.
| [in] | ctx | talloc context from which to allocate memory This function allocates a new osmo_stream_cli and initializes it with default values (5s reconnect timer, TCP protocol) |
| void osmo_stream_cli_destroy | ( | struct osmo_stream_cli * | cli | ) |
Destroy a Osmocom stream client (includes close).
| [in] | cli | Stream Client to destroy |
| void * osmo_stream_cli_get_data | ( | struct osmo_stream_cli * | cli | ) |
Retrieve application private data of the stream client socket.
| [in] | cli | Stream Client to modify |
| int osmo_stream_cli_get_fd | ( | const struct osmo_stream_cli * | cli | ) |
Retrieve file descriptor of the stream client socket.
| [in] | cli | Stream Client of which we want to obtain the file descriptor |
Referenced by osmo_stream_cli_get_sockname().
| struct osmo_io_fd * osmo_stream_cli_get_iofd | ( | const struct osmo_stream_cli * | cli | ) |
Retrieve osmo_io descriptor of the stream client socket.
This function must not be called on a stream client in legacy osmo_fd mode! The iofd is only valid once/after osmo_stream_cli_open() has successfully returned.
| [in] | cli | Stream Client of which we want to obtain the file descriptor |
| 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()).
| [in] | cli | stream_cli whose name is to be retrieved |
| struct osmo_fd * osmo_stream_cli_get_ofd | ( | struct osmo_stream_cli * | cli | ) |
Retrieve Osmocom File Descriptor of the stream client socket.
This function only works in case you operate osmo_stream_cli in osmo_fd mode!
| [in] | cli | Stream Client to modify |
| char * osmo_stream_cli_get_sockname | ( | const struct osmo_stream_cli * | cli | ) |
Retrieve the stream client socket description.
Calling this function will build a string that describes the socket in terms of its local/remote address/port. The returned name is stored in a static buffer; it is hence not re-entrant or thread-safe.
| [in] | cli | Stream Client to examine |
References osmo_stream_cli_get_fd().
| bool osmo_stream_cli_is_connected | ( | struct osmo_stream_cli * | cli | ) |
Check if Osmocom Stream Client is in connected state.
| [in] | cli | Osmocom Stream Client |
Referenced by osmo_stream_cli_send().
| int osmo_stream_cli_open | ( | struct osmo_stream_cli * | cli | ) |
Open connection of an Osmocom stream client.
This will initiate an non-blocking outbound connect to the configured destination (server) address. By default the client will automatically attempt to reconnect after default timeout. To disable this, use osmo_stream_cli_set_reconnect_timeout() before calling this function.
| [in] | cli | Stream Client to connect |
| int osmo_stream_cli_open2 | ( | struct osmo_stream_cli * | cli, |
| int | reconnect | ||
| ) |
DEPRECATED: use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead! Open connection of an Osmocom stream client.
| [in] | cli | Stream Client to connect |
| [in] | reconect | 1 if we should not automatically 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 unless negative timeout was explicitly set via osmo_stream_cli_set_reconnect_timeout() call), we close any existing connection (if any) and schedule a re-connect timer
| int osmo_stream_cli_recv | ( | struct osmo_stream_cli * | cli, |
| struct msgb * | msg | ||
| ) |
Receive data via an Osmocom stream client in osmo_fd mode.
| [in] | cli | Stream Client through which we want to send |
| msg | pre-allocate message buffer to which received data is appended |
Application programs using the legacy osmo_fd mode of osmo_stream_cli will use this function to read/receive from a stream client socket after they have been notified that it is readable (via select/poll).
If conn is an SCTP connection, additional specific considerations shall be taken:
| void osmo_stream_cli_send | ( | struct osmo_stream_cli * | cli, |
| struct msgb * | msg | ||
| ) |
Enqueue data to be sent via an Osmocom stream client.
This is the function you use for writing/sending/transmitting data via the osmo_stream_cli.
| [in] | cli | Stream Client through which we want to send |
| [in] | msg | Message buffer to enqueue in transmit queue |
References osmo_stream_cli_is_connected().
| void osmo_stream_cli_set_addr | ( | struct osmo_stream_cli * | cli, |
| const char * | addr | ||
| ) |
Set the remote address to which we connect.
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | addr | Remote IP address |
References 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 one address (such as SCTP) Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | addr | Remote IP address set |
Referenced by osmo_stream_cli_set_addr().
| 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.
The call-back function registered via this function will be called upon completion of the non-blocking outbound connect operation.
| [in] | cli | Stream Client to modify |
| [in] | connect_cb | Call-back function to be called upon connect |
| void osmo_stream_cli_set_data | ( | struct osmo_stream_cli * | cli, |
| void * | data | ||
| ) |
Set application private data of the stream client socket.
| [in] | cli | Stream Client to modify |
| [in] | data | User-specific data (available in call-back functions) |
| 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.
| [in] | cli | Stream Client to modify |
| [in] | disconnect_cb | Call-back function to be called upon disconnect |
| int osmo_stream_cli_set_domain | ( | struct osmo_stream_cli * | cli, |
| int | domain | ||
| ) |
Set the socket type for the stream server link.
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | type | Socket Domain (like AF_UNSPEC (default for IP), AF_UNIX, AF_INET, ...) |
| 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.
Setting this will automatically set the IP DSCP option on any socket established via osmo_stream_cli_open or any re-connect. This can be set either before or after opening the socket.
| [in] | cli | Stream client whose sockets are to be configured |
| [in] | ip_dscp | DSCP value. Value range 0..63. |
| 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).
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | port | Local host name |
References 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 bind.
Useful for protocols allowing bind to more than one address (such as SCTP) Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | addr | Local IP address set |
Referenced by osmo_stream_cli_set_local_addr().
| 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).
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | port | Local port number |
| void osmo_stream_cli_set_name | ( | struct osmo_stream_cli * | cli, |
| const char * | name | ||
| ) |
Set a name on the cli object (used during logging).
| [in] | cli | stream_cli whose name is to be set |
| [in] | name | the name to be set on cli |
| 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 automatically set the NODELAY socket option on any socket established via osmo_stream_cli_open or any re-connect. This can be set either before or after opening the socket.
| [in] | cli | Stream client whose sockets are to be configured |
| [in] | nodelay | whether to set (true) NODELAY before connect() |
| 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.
| [in] | cli | stream client on which to set parameter. |
| [in] | par | identifier of the parameter to be set. |
| [in] | val | value of the parameter to be set. |
| [in] | val_len | length of the parameter value. |
| void osmo_stream_cli_set_port | ( | struct osmo_stream_cli * | cli, |
| uint16_t | port | ||
| ) |
Set the remote port number to which we connect.
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | port | Remote port number |
| int osmo_stream_cli_set_priority | ( | struct osmo_stream_cli * | cli, |
| int | sk_prio | ||
| ) |
Set the priority value of the stream socket.
Setting this will automatically set the socket priority option on any socket established via osmo_stream_cli_open or any re-connect. This can be set either before or after opening the socket.
| [in] | cli | Stream client whose sockets are to be configured |
| [in] | sk_prio | priority value. Values outside 0..6 require CAP_NET_ADMIN. |
| void osmo_stream_cli_set_proto | ( | struct osmo_stream_cli * | cli, |
| uint16_t | proto | ||
| ) |
Set the protocol for the stream client socket.
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | proto | Protocol (like IPPROTO_TCP (default), IPPROTO_SCTP, ...) |
| 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.
This function will implicitly configure osmo_stream_cli to use legacy osmo_ofd mode.
| [in] | cli | Stream Client to modify |
| [in] | read_cb | Call-back function to be called when we want to read |
| 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.
This function will implicitly configure osmo_stream_cli to use osmo_iofd mode.
| [in] | cli | Stream Client to modify |
| [in] | read_cb | Call-back function to be called when data was read from the socket |
| void osmo_stream_cli_set_reconnect_timeout | ( | struct osmo_stream_cli * | cli, |
| int | timeout | ||
| ) |
Set the reconnect time of the stream client socket.
| [in] | cli | Stream Client to modify |
| [in] | timeout | Re-connect timeout in seconds or negative value to disable auto-reconnection |
| 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.
| [in,out] | cli | Stream Client to modify |
| [in] | segmentation_cb | Target segmentation callback |
| 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.
| [in] | cli | Stream Client to modify |
| [in] | size | maximum amount of msgbs which can be queued in the internal tx queue. |
The maximum length queue default value is 1024 msgbs.
| int osmo_stream_cli_set_type | ( | struct osmo_stream_cli * | cli, |
| int | type | ||
| ) |
Set the socket type for the stream server link.
Any changes to this setting will only become active upon next (re)connect.
| [in] | cli | Stream Client to modify |
| [in] | type | Socket Type (like SOCK_STREAM (default), SOCK_SEQPACKET, ...) |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmux protocol header. More...
#include <osmux.h>
Data Fields | |
| uint8_t | seq |
| uint8_t | circuit_id |
| uint8_t | data [0] |
Osmux protocol header.
OSmux header:
rtp_m (1 bit): RTP M field (RFC3550, RFC4867)
ft (2 bits): 0=signalling, 1=voice, 2=dummy
ctr (3 bits): Number of batched AMR payloads (starting 0)
amr_f (1 bit): AMR F field (RFC3267)
amr_q (1 bit): AMR Q field (RFC3267)
seq (8 bits): Combination of RTP timestamp and seq. number
circuit_id (8 bits): Circuit ID, ie. Call identifier.
amr_ft (4 bits): AMR FT field (RFC3267)
amr_cmr (4 bits): AMR CMT field (RFC3267)
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom datagram socket helpers. More...
Go to the source code of this file.
Functions | |
| struct osmo_dgram_tx * | osmo_dgram_tx_create (void *ctx) |
| Create an Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_destroy (struct osmo_dgram_tx *conn) |
| Destroy a Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_set_addr (struct osmo_dgram_tx *conn, const char *addr) |
| Set the remote address to which we transmit. More... | |
| void | osmo_dgram_tx_set_port (struct osmo_dgram_tx *conn, uint16_t port) |
| Set the remote port to which we transmit. More... | |
| void | osmo_dgram_tx_set_local_addr (struct osmo_dgram_tx *conn, const char *addr) |
| Set the local address from which we transmit. More... | |
| void | osmo_dgram_tx_set_local_port (struct osmo_dgram_tx *conn, uint16_t port) |
| Set the local port from which we transmit. More... | |
| void | osmo_dgram_tx_set_data (struct osmo_dgram_tx *conn, void *data) |
| Set application private data of the datagram transmitter. More... | |
| int | osmo_dgram_tx_open (struct osmo_dgram_tx *conn) |
| Open connection of an Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_close (struct osmo_dgram_tx *conn) |
| Close an Osmocom Datagram Transmitter. More... | |
| void | osmo_dgram_tx_send (struct osmo_dgram_tx *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom datagram transmitter. More... | |
| struct osmo_dgram_rx * | osmo_dgram_rx_create (void *ctx) |
| Create an Osmocom datagram receiver. More... | |
| void | osmo_dgram_rx_set_addr (struct osmo_dgram_rx *conn, const char *addr) |
| Set the local address to which we bind. More... | |
| void | osmo_dgram_rx_set_port (struct osmo_dgram_rx *conn, uint16_t port) |
| Set the local port to which we bind. More... | |
| void | osmo_dgram_rx_set_read_cb (struct osmo_dgram_rx *conn, int(*read_cb)(struct osmo_dgram_rx *conn)) |
| Set the read() call-back of the datagram receiver. More... | |
| void | osmo_dgram_rx_destroy (struct osmo_dgram_rx *conn) |
| Destroy the datagram receiver. More... | |
| int | osmo_dgram_rx_open (struct osmo_dgram_rx *conn) |
| Open the datagram receiver. More... | |
| void | osmo_dgram_rx_close (struct osmo_dgram_rx *conn) |
| Close the datagram receiver and unregister from select loop Does not destroy the datagram receiver, merely closes it! More... | |
| int | osmo_dgram_rx_recv (struct osmo_dgram_rx *conn, struct msgb *msg) |
| Receive data via Osmocom datagram receiver. More... | |
| struct osmo_dgram * | osmo_dgram_create (void *ctx) |
| Create an Osmocom datagram transceiver (bidirectional) More... | |
| void | osmo_dgram_destroy (struct osmo_dgram *conn) |
| Destroy a Osmocom datagram transceiver. More... | |
| int | osmo_dgram_open (struct osmo_dgram *conn) |
| Open the datagram transceiver. More... | |
| void | osmo_dgram_close (struct osmo_dgram *conn) |
| Close an Osmocom Datagram Transceiver. More... | |
| void | osmo_dgram_set_local_addr (struct osmo_dgram *conn, const char *addr) |
| Set the local address to which we bind. More... | |
| void | osmo_dgram_set_remote_addr (struct osmo_dgram *conn, const char *addr) |
| Set the remote address to which we transmit/connect. More... | |
| void | osmo_dgram_set_local_port (struct osmo_dgram *conn, uint16_t port) |
| Set the local port to which we bind. More... | |
| void | osmo_dgram_set_remote_port (struct osmo_dgram *conn, uint16_t port) |
| Set the remote port to which we transmit. More... | |
| void | osmo_dgram_set_read_cb (struct osmo_dgram *conn, int(*read_cb)(struct osmo_dgram *conn)) |
| Set the read() call-back of the datagram receiver. More... | |
| void | osmo_dgram_set_data (struct osmo_dgram *conn, void *data) |
| Set application private data of the datagram transmitter. More... | |
| void * | osmo_dgram_get_data (struct osmo_dgram *conn) |
| Get application private data of the datagram transceiver. More... | |
| void | osmo_dgram_send (struct osmo_dgram *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom datagram transceiver. More... | |
| int | osmo_dgram_recv (struct osmo_dgram *conn, struct msgb *msg) |
| Receive data via Osmocom datagram transceiver. More... | |
Osmocom datagram socket helpers.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint8_t | byte0 |
| uint8_t | type |
| uint16_t | length |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint8_t | proto |
| uint8_t | proto_ext |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Files | |
| file | datagram.c |
| Osmocom datagram socket helpers. | |
| file | jibuf.c |
| Osmocom Jitter Buffer helpers. | |
| file | osmux.c |
| Osmocom multiplex protocol helpers. | |
| file | osmux_input.c |
| Osmocom multiplex protocol helpers (input) | |
| file | osmux_output.c |
| Osmocom multiplex protocol helpers (output) | |
| file | stream_cli.c |
| file | stream_srv.c |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
| Osmocom Datagram Socket | This code is intended to abstract any use of datagram type sockets, such as UDP |
| Osmocom Jitter Buffer | |
| Osmocom Stream Server | This code is intended to abstract any server-side use of stream-type sockets, such as TCP and SCTP |
| Osmocom Stream Client | This code is intended to abstract any client use of stream-type sockets, such as TCP and SCTP |
| Osmocom Multiplex Protocol | This code implements a variety of utility functions related to the OSMUX user-plane multiplexing protocol, an efficient alternative to plain UDP/RTP streams for voice transport in back-haul of cellular networks |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
#include <stdio.h>#include <unistd.h>#include <stdlib.h>#include <errno.h>#include <string.h>#include <time.h>#include <sys/fcntl.h>#include <sys/socket.h>#include <sys/ioctl.h>#include <arpa/inet.h>#include <netinet/in.h>#include <netinet/tcp.h>#include <osmocom/core/timer.h>#include <osmocom/core/select.h>#include <osmocom/core/utils.h>#include <osmocom/gsm/tlv.h>#include <osmocom/core/msgb.h>#include <osmocom/core/osmo_io.h>#include <osmocom/core/panic.h>#include <osmocom/core/logging.h>#include <osmocom/core/talloc.h>#include <osmocom/core/socket.h>#include <osmocom/netif/stream.h>#include <osmocom/netif/stream_private.h>#include "config.h"#include <osmocom/netif/sctp.h>Macros | |
| #define | LOGSCLI(cli, level, fmt, args...) |
| #define | OSMO_STREAM_CLI_F_RECONF (1 << 0) |
| #define | OSMO_STREAM_CLI_F_NODELAY (1 << 1) |
| #define | IN_CB_MASK_CONNECT_CB (1 << 0) |
| #define | IN_CB_MASK_DISCONNECT_CB (1 << 1) |
| #define | IN_CB_MASK_READ_CB (1 << 2) |
Enumerations | |
| enum | osmo_stream_cli_state { STREAM_CLI_STATE_CLOSED , STREAM_CLI_STATE_WAIT_RECONNECT , STREAM_CLI_STATE_CONNECTING , STREAM_CLI_STATE_CONNECTED , STREAM_CLI_STATE_MAX } |
Functions | |
| void | osmo_stream_cli_close (struct osmo_stream_cli *cli) |
| Close an Osmocom Stream Client. More... | |
| void | osmo_stream_cli_reconnect (struct osmo_stream_cli *cli) |
| Re-connect an Osmocom Stream Client. More... | |
| bool | osmo_stream_cli_is_connected (struct osmo_stream_cli *cli) |
| Check if Osmocom Stream Client is in connected state. More... | |
| int | osmo_stream_cli_get_fd (const struct osmo_stream_cli *cli) |
| Retrieve file descriptor of the stream client socket. More... | |
| struct osmo_io_fd * | osmo_stream_cli_get_iofd (const struct osmo_stream_cli *cli) |
| Retrieve osmo_io descriptor of the stream client socket. More... | |
| struct osmo_stream_cli * | osmo_stream_cli_create (void *ctx) |
| Create an Osmocom stream client. More... | |
| void | osmo_stream_cli_set_name (struct osmo_stream_cli *cli, const char *name) |
| Set a name on the cli object (used during logging). More... | |
| 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()). More... | |
| void | osmo_stream_cli_set_addr (struct osmo_stream_cli *cli, const char *addr) |
| Set the remote address to which we connect. More... | |
| 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. More... | |
| void | osmo_stream_cli_set_port (struct osmo_stream_cli *cli, uint16_t port) |
| Set the remote port number to which we connect. More... | |
| 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). More... | |
| 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). More... | |
| 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. More... | |
| void | osmo_stream_cli_set_proto (struct osmo_stream_cli *cli, uint16_t proto) |
| Set the protocol for the stream client socket. More... | |
| 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. More... | |
| int | osmo_stream_cli_set_type (struct osmo_stream_cli *cli, int type) |
| Set the socket type for the stream server link. More... | |
| int | osmo_stream_cli_set_domain (struct osmo_stream_cli *cli, int domain) |
| Set the socket type for the stream server link. More... | |
| void | osmo_stream_cli_set_reconnect_timeout (struct osmo_stream_cli *cli, int timeout) |
| Set the reconnect time of the stream client socket. More... | |
| void | osmo_stream_cli_set_data (struct osmo_stream_cli *cli, void *data) |
| Set application private data of the stream client socket. More... | |
| void * | osmo_stream_cli_get_data (struct osmo_stream_cli *cli) |
| Retrieve application private data of the stream client socket. More... | |
| 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. More... | |
| char * | osmo_stream_cli_get_sockname (const struct osmo_stream_cli *cli) |
| Retrieve the stream client socket description. More... | |
| struct osmo_fd * | osmo_stream_cli_get_ofd (struct osmo_stream_cli *cli) |
| Retrieve Osmocom File Descriptor of the stream client socket. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_cli_destroy (struct osmo_stream_cli *cli) |
| Destroy a Osmocom stream client (includes close). More... | |
| int | osmo_stream_cli_open2 (struct osmo_stream_cli *cli, int reconnect) |
| DEPRECATED: use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead! Open connection of an Osmocom stream client. More... | |
| void | osmo_stream_cli_set_nodelay (struct osmo_stream_cli *cli, bool nodelay) |
| Set the NODELAY socket option to avoid Nagle-like behavior. More... | |
| int | osmo_stream_cli_set_priority (struct osmo_stream_cli *cli, int sk_prio) |
| Set the priority value of the stream socket. More... | |
| 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. More... | |
| int | osmo_stream_cli_open (struct osmo_stream_cli *cli) |
| Open connection of an Osmocom stream client. More... | |
| void | osmo_stream_cli_send (struct osmo_stream_cli *cli, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom stream client. More... | |
| int | osmo_stream_cli_recv (struct osmo_stream_cli *cli, struct msgb *msg) |
| Receive data via an Osmocom stream client in osmo_fd mode. More... | |
| void | osmo_stream_cli_clear_tx_queue (struct osmo_stream_cli *cli) |
| Clear the transmit queue of the stream client. More... | |
| 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. More... | |
| #define LOGSCLI | ( | cli, | |
| level, | |||
| fmt, | |||
| args... | |||
| ) |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint8_t | data [0] |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
This code is intended to abstract any server-side use of stream-type sockets, such as TCP and SCTP. More...
Typedefs | |
| typedef int(* | osmo_stream_srv_link_accept_cb_t) (struct osmo_stream_srv_link *link, int fd) |
| typedef int(* | osmo_stream_srv_read_cb_t) (struct osmo_stream_srv *conn) |
| typedef int(* | osmo_stream_srv_closed_cb_t) (struct osmo_stream_srv *conn) |
| typedef 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. More... | |
| typedef int(* | osmo_stream_srv_segmentation_cb_t) (struct msgb *msg) |
Functions | |
| struct osmo_stream_srv_link * | osmo_stream_srv_link_create (void *ctx) |
| Create an Osmocom Stream Server Link. More... | |
| void | osmo_stream_srv_link_destroy (struct osmo_stream_srv_link *link) |
| Destroy the stream server link. More... | |
| 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). More... | |
| 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()). More... | |
| 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. More... | |
| int | osmo_stream_srv_link_set_priority (struct osmo_stream_srv_link *link, int sk_prio) |
| Set the priority value of the stream socket. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_addr (struct osmo_stream_srv_link *link, const char *addr) |
| Set the local address to which we bind. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_proto (struct osmo_stream_srv_link *link, uint16_t proto) |
| Set the protocol for the stream server link. More... | |
| int | osmo_stream_srv_link_set_type (struct osmo_stream_srv_link *link, int type) |
| Set the socket type for the stream server link. More... | |
| int | osmo_stream_srv_link_set_domain (struct osmo_stream_srv_link *link, int domain) |
| Set the socket type for the stream server link. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_data (struct osmo_stream_srv_link *link, void *data) |
| Set application private data of the stream server link. More... | |
| void * | osmo_stream_srv_link_get_data (struct osmo_stream_srv_link *link) |
| Retrieve application private data of the stream server link. More... | |
| 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. More... | |
| char * | osmo_stream_srv_link_get_sockname (const struct osmo_stream_srv_link *link) |
| Retrieve description of the stream server link e. More... | |
| struct osmo_fd * | osmo_stream_srv_link_get_ofd (struct osmo_stream_srv_link *link) |
| Retrieve Osmocom File Descriptor of the stream server link. More... | |
| int | osmo_stream_srv_link_get_fd (const struct osmo_stream_srv_link *link) |
| Retrieve File Descriptor of the stream server link. More... | |
| bool | osmo_stream_srv_link_is_opened (const struct osmo_stream_srv_link *link) |
| Check whether the stream server link is opened. More... | |
| int | osmo_stream_srv_link_open (struct osmo_stream_srv_link *link) |
| Open the stream server link. More... | |
| void | osmo_stream_srv_link_close (struct osmo_stream_srv_link *link) |
| Close the stream server link and unregister from select loop. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_srv_set_name (struct osmo_stream_srv *conn, const char *name) |
| Set a name on the srv object (used during logging). More... | |
| 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()). More... | |
| 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. More... | |
| void | osmo_stream_srv_set_closed_cb (struct osmo_stream_srv *conn, osmo_stream_srv_closed_cb_t closed_cb) |
| Set the call-back function called when the stream server socket was closed. More... | |
| void * | osmo_stream_srv_get_data (struct osmo_stream_srv *conn) |
| Retrieve application private data of the stream server. More... | |
| struct osmo_stream_srv_link * | osmo_stream_srv_get_master (struct osmo_stream_srv *conn) |
| Retrieve the master (Link) from a Stream Server. More... | |
| const char * | osmo_stream_srv_get_sockname (const struct osmo_stream_srv *conn) |
| Retrieve the stream server socket description. More... | |
| struct osmo_fd * | osmo_stream_srv_get_ofd (struct osmo_stream_srv *conn) |
| Retrieve Osmocom File Descriptor of a stream server in osmo_fd mode. More... | |
| int | osmo_stream_srv_get_fd (const struct osmo_stream_srv *conn) |
| Retrieve File Descriptor of the stream server. More... | |
| struct osmo_io_fd * | osmo_stream_srv_get_iofd (const struct osmo_stream_srv *srv) |
| Retrieve osmo_io descriptor of the stream server socket. More... | |
| void | osmo_stream_srv_destroy (struct osmo_stream_srv *conn) |
| Destroy given Stream Server. More... | |
| 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. More... | |
| void | osmo_stream_srv_set_data (struct osmo_stream_srv *conn, void *data) |
| Set application private data of the stream server. More... | |
| 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. More... | |
| void | osmo_stream_srv_send (struct osmo_stream_srv *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom stream server. More... | |
| int | osmo_stream_srv_recv (struct osmo_stream_srv *conn, struct msgb *msg) |
| Receive data via an Osmocom stream server in osmo_fd mode. More... | |
| void | osmo_stream_srv_clear_tx_queue (struct osmo_stream_srv *conn) |
This code is intended to abstract any server-side use of stream-type sockets, such as TCP and SCTP.
The Osmocom stream socket helper is an abstraction layer for connected SOCK_STREAM/SOCK_SEQPACKET sockets. It encapsulates common functionality like binding, accepting client connections, etc.
osmo_stream_srv can operate in two different modes:
For any new applications, you definitely should use the modern mode, as it provides you with a higher layer of abstraction and allows you to perform efficient I/O using the io_uring backend of osmo_io.
The two main objects are osmo_stream_srv_link (main server accept()ing incoming connections) and osmo_stream_srv (a single given connection from a remote client).
A typical stream_srv usage would look like this:
Whenever a client connects to your listening socket, the connection will now be automatically accept()ed and the registered accept_cb call-back called. From within that accept_cb, you then
Whenever data from a client arrives on a connection, your registered read_cb will be called together with a message buffer containing the received data. Ownership of the message buffer is transferred into the call-back, i.e. in your application. It's your responsibility to eventually msgb_free() it after usage.
Whenever your application wants to transmit something to a given connection, it uses the osmo_stream_srv_send() function.
| typedef 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.
| [in] | conn | Stream Server that got receive event. |
| [in] | res | return value of the read()/recvmsg()/... call, or -errno in case of error. |
| [in] | msg | message buffer containing the read data. Ownership is transferred to the call-back, and it must make sure to msgb_free() it eventually! |
| 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.
This is the function an application traditionally calls from within the accept_cb call-back of the osmo_stream_srv_link. It creates a new osmo_stream_srv within that link.
New users/programs should use osmo_stream_srv_create2 to operate in osmo_io mode instead.
| [in] | ctx | talloc allocation context from which to allocate |
| [in] | link | Stream Server Link to which we belong |
| [in] | fd | system file descriptor of the new connection |
| [in] | read_cb | Call-back to call when the socket is readable |
| [in] | closed_cb | Call-back to call when the connection is closed |
| [in] | data | User data to save in the new Stream Server struct |
| 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.
This is the function an application typically calls from within the accept_cb call-back of the osmo_stream_srv_link. It creates a new osmo_stream_srv in osmo_io mode within that link.
| [in] | ctx | talloc allocation context from which to allocate |
| [in] | link | Stream Server Link to which we belong |
| [in] | fd | system file descriptor of the new connection |
| [in] | data | User data to save in the new Stream Server struct |
| void osmo_stream_srv_destroy | ( | struct osmo_stream_srv * | conn | ) |
Destroy given Stream Server.
This function closes the Stream Server socket, unregisters from the underlying I/O mechanism, invokes the connection's closed_cb() callback to allow API users to clean up any associated state they have for this connection, and then de-allocates associated memory.
| [in] | conn | Stream Server to be destroyed |
| void * osmo_stream_srv_get_data | ( | struct osmo_stream_srv * | conn | ) |
Retrieve application private data of the stream server.
| [in] | conn | Stream Server |
| int osmo_stream_srv_get_fd | ( | const struct osmo_stream_srv * | conn | ) |
Retrieve File Descriptor of the stream server.
| [in] | conn | Stream Server |
Referenced by osmo_stream_srv_get_sockname().
| struct osmo_io_fd * osmo_stream_srv_get_iofd | ( | const struct osmo_stream_srv * | srv | ) |
Retrieve osmo_io descriptor of the stream server socket.
This function must not be called on a stream server in legacy osmo_fd mode!
| [in] | srv | Stream Server of which we want to obtain the osmo_io descriptor |
| struct osmo_stream_srv_link * osmo_stream_srv_get_master | ( | struct osmo_stream_srv * | conn | ) |
Retrieve the master (Link) from a Stream Server.
| [in] | conn | Stream Server of which we want to know the Link |
| 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()).
| [in] | conn | server whose name is to be retrieved |
| struct osmo_fd * osmo_stream_srv_get_ofd | ( | struct osmo_stream_srv * | conn | ) |
Retrieve Osmocom File Descriptor of a stream server in osmo_fd mode.
| [in] | conn | Stream Server |
| const char * osmo_stream_srv_get_sockname | ( | const struct osmo_stream_srv * | conn | ) |
Retrieve the stream server socket description.
The returned name is stored in a static buffer; it is hence not re-entrant or thread-safe!
| [in] | cli | Stream Server to examine |
References osmo_stream_srv_get_fd().
| 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, merely closes it!
| [in] | link | Stream Server Link to close |
References osmo_stream_srv_link_is_opened().
Referenced by osmo_stream_srv_link_destroy().
| 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 individual connections from remote clients.
| [in] | ctx | talloc allocation context |
| void osmo_stream_srv_link_destroy | ( | struct osmo_stream_srv_link * | link | ) |
Destroy the stream server link.
Closes + Releases Memory.
| [in] | link | Stream Server Link |
References osmo_stream_srv_link_close().
| void * osmo_stream_srv_link_get_data | ( | struct osmo_stream_srv_link * | link | ) |
Retrieve application private data of the stream server link.
| [in] | link | Stream Server Link to modify |
| int osmo_stream_srv_link_get_fd | ( | const struct osmo_stream_srv_link * | link | ) |
Retrieve File Descriptor of the stream server link.
| [in] | conn | Stream Server Link |
| 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()).
| [in] | link | server link whose name is to be retrieved |
| struct osmo_fd * osmo_stream_srv_link_get_ofd | ( | struct osmo_stream_srv_link * | link | ) |
Retrieve Osmocom File Descriptor of the stream server link.
| [in] | link | Stream Server Link |
| char * osmo_stream_srv_link_get_sockname | ( | const struct osmo_stream_srv_link * | link | ) |
Retrieve description of the stream server link e.
g. 127.0.0.1:1234. Calling this function will build a string that describes the socket in terms of its local/remote address/port. The returned name is stored in a static buffer; it is hence not re-entrant or thread-safe.
| [in] | link | Stream Server Link to examine |
| bool osmo_stream_srv_link_is_opened | ( | const struct osmo_stream_srv_link * | link | ) |
Check whether the stream server link is opened.
| [in] | link | Stream Server Link to check |
Referenced by osmo_stream_srv_link_close().
| 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 configured ip/port.
| [in] | link | Stream Server Link to open |
| void osmo_stream_srv_link_set_accept_cb | ( | struct osmo_stream_srv_link * | link, |
| int(*)(struct osmo_stream_srv_link *link, int fd) | accept_cb | ||
| ) |
Set the accept() call-back of the stream server link.
The provided call-back will be called whenever a new inbound connection is accept()ed. The call-back then typically creates a new osmo_stream_srv. If the call-back returns a negative value, the file descriptor will be closed.
| [in] | link | Stream Server Link |
| [in] | accept_cb | Call-back function executed upon accept() |
| void osmo_stream_srv_link_set_addr | ( | struct osmo_stream_srv_link * | link, |
| const char * | addr | ||
| ) |
Set the local address to which we bind.
Any changes to this setting will only become active upon next (re)connect.
| [in] | link | Stream Server Link to modify |
| [in] | addr | Local IP address |
References 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 address (such as SCTP) Any changes to this setting will only become active upon next (re)connect.
| [in] | link | Stream Server Link to modify |
| [in] | addr | Local IP address |
Referenced by osmo_stream_srv_link_set_addr().
| void osmo_stream_srv_link_set_data | ( | struct osmo_stream_srv_link * | link, |
| void * | data | ||
| ) |
Set application private data of the stream server link.
| [in] | link | Stream Server Link to modify |
| [in] | data | User-specific data (available in call-back functions) |
| int osmo_stream_srv_link_set_domain | ( | struct osmo_stream_srv_link * | link, |
| int | domain | ||
| ) |
Set the socket type for the stream server link.
Any changes to this setting will only become active upon next (re)connect.
| [in] | link | Stream Server Link to modify |
| [in] | type | Socket Domain (like AF_UNSPEC (default for IP), AF_UNIX, AF_INET, ...) |
| 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.
Setting this will automatically set the IP DSCP option on any socket on any socket established via this server link, before calling the accept_cb().
| [in] | link | server link whose sockets are to be configured |
| [in] | ip_dscp | DSCP value. Value range 0..63. |
| 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).
| [in] | link | server link whose name is to be set. The name is copied into the osmo_stream_srv_link, so the caller memory is not required to be valid beyond the call of this function. |
| [in] | name | the name to be set on link |
| 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 automatically set the NODELAY socket option on any socket established via this server link, before calling the accept_cb()
| [in] | link | server link whose sockets are to be configured |
| [in] | nodelay | whether to set (true) NODELAY after accept |
| 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.
| [in] | cli | stream client on which to set parameter. |
| [in] | par | identifier of the parameter to be set. |
| [in] | val | value of the parameter to be set. |
| [in] | val_len | length of the parameter value. |
| 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.
Any changes to this setting will only become active upon next (re)connect.
| [in] | link | Stream Server Link to modify |
| [in] | port | Local port number |
| int osmo_stream_srv_link_set_priority | ( | struct osmo_stream_srv_link * | link, |
| int | sk_prio | ||
| ) |
Set the priority value of the stream socket.
Setting this will automatically set the socket priority option on any socket established via this server link, before calling the accept_cb().
| [in] | link | server link whose sockets are to be configured |
| [in] | sk_prio | priority value. Values outside 0..6 require CAP_NET_ADMIN. |
| void osmo_stream_srv_link_set_proto | ( | struct osmo_stream_srv_link * | link, |
| uint16_t | proto | ||
| ) |
Set the protocol for the stream server link.
Any changes to this setting will only become active upon next (re)connect.
| [in] | link | Stream Server Link to modify |
| [in] | proto | Protocol (like IPPROTO_TCP (default), IPPROTO_SCTP, ...) |
| 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.
| [in] | link | Stream Server Link to modify |
| [in] | size | maximum amount of msgbs which can be queued in the internal tx queue. |
The maximum length queue default value is 1024 msgbs.
| int osmo_stream_srv_link_set_type | ( | struct osmo_stream_srv_link * | link, |
| int | type | ||
| ) |
Set the socket type for the stream server link.
Any changes to this setting will only become active upon next (re)connect.
| [in] | link | Stream Server Link to modify |
| [in] | type | Socket Type (like SOCK_STREAM (default), SOCK_SEQPACKET, ...) |
| int osmo_stream_srv_recv | ( | struct osmo_stream_srv * | conn, |
| struct msgb * | msg | ||
| ) |
Receive data via an Osmocom stream server in osmo_fd mode.
| [in] | conn | Stream Server from which to receive |
| msg | pre-allocate message buffer to which received data is appended |
Application programs using the legacy osmo_fd mode of osmo_stream_srv will use this function to read/receive from a stream socket after they have been notified that it is readable (via select/poll).
If conn is an SCTP connection, additional specific considerations shall be taken:
| void osmo_stream_srv_send | ( | struct osmo_stream_srv * | conn, |
| struct msgb * | msg | ||
| ) |
Enqueue data to be sent via an Osmocom stream server.
| [in] | conn | Stream Server through which we want to send |
| [in] | msg | Message buffer to enqueue in transmit queue |
| void osmo_stream_srv_set_closed_cb | ( | struct osmo_stream_srv * | conn, |
| osmo_stream_srv_closed_cb_t | closed_cb | ||
| ) |
Set the call-back function called when the stream server socket was closed.
Whenever the socket was closed (network error, client disconnect, etc.), the user-provided call-back function given here is called. This is typically used by the application to clean up any of its internal state related to this specific client/connection.
| [in] | conn | Stream Server to modify |
| [in] | closed_cb | Call-back function to be called when the connection was closed |
| void osmo_stream_srv_set_data | ( | struct osmo_stream_srv * | conn, |
| void * | data | ||
| ) |
Set application private data of the stream server.
| [in] | conn | Stream Server to modify |
| [in] | data | User-specific data (available in call-back functions) |
| 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.
and then automatically destroy the stream with osmo_stream_srv_destroy(). This function disables queuing of new messages on the connection and also disables reception of new messages on the connection.
| [in] | conn | Stream Server to modify |
| void osmo_stream_srv_set_name | ( | struct osmo_stream_srv * | conn, |
| const char * | name | ||
| ) |
Set a name on the srv object (used during logging).
| [in] | conn | server whose name is to be set. The name is copied into the osmo_stream_srv_link, so the caller memory is not required to be valid beyond the call of this function. |
| [in] | name | the name to be set on conn |
| 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.
This function only works with osmo_stream_srv in osmo_io mode, created by osmo_stream_srv_create2()!
Whenever data is received on the osmo_stram_srv, the read_cb call-back function of the user application is called.
| [in] | conn | Stream Server to modify |
| [in] | read_cb | Call-back function to be called when data was read |
| 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.
A segmentation call-back can optionally be used when a packet based protocol (like TCP) is used within a STREAM style socket that does not preserve message boundaries within the stream. If a segmentation call-back is given, the osmo_stream_srv library code will makes sure that the read_cb called only for complete single messages, and not arbitrary segments of the stream.
This function only works with osmo_stream_srv in osmo_io mode, created by osmo_stream_srv_create2()! The connection has to have been established prior to calling this function.
| [in,out] | conn | Target Stream Server to modify |
| [in] | segmentation_cb | Segmentation callback to be set |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Files | |
| file | amr.h [code] |
| file | datagram.h [code] |
| Osmocom datagram socket helpers. | |
| file | ipa.h [code] |
| file | ipa_unit.h [code] |
| file | jibuf.h [code] |
| Osmocom Jitter Buffer helpers. | |
| file | osmux.h [code] |
| Osmocom multiplex protocol helpers. | |
| file | prim.h [code] |
| file | rs232.h [code] |
| file | rtp.h [code] |
| file | sctp.h [code] |
| file | stream.h [code] |
| file | stream_private.h [code] |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
This code is intended to abstract any use of datagram type sockets, such as UDP. More...
Files | |
| file | datagram.h |
| Osmocom datagram socket helpers. | |
| file | datagram.c |
| Osmocom datagram socket helpers. | |
Functions | |
| struct osmo_dgram_tx * | osmo_dgram_tx_create (void *ctx) |
| Create an Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_destroy (struct osmo_dgram_tx *conn) |
| Destroy a Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_set_addr (struct osmo_dgram_tx *conn, const char *addr) |
| Set the remote address to which we transmit. More... | |
| void | osmo_dgram_tx_set_port (struct osmo_dgram_tx *conn, uint16_t port) |
| Set the remote port to which we transmit. More... | |
| void | osmo_dgram_tx_set_local_addr (struct osmo_dgram_tx *conn, const char *addr) |
| Set the local address from which we transmit. More... | |
| void | osmo_dgram_tx_set_local_port (struct osmo_dgram_tx *conn, uint16_t port) |
| Set the local port from which we transmit. More... | |
| void | osmo_dgram_tx_set_data (struct osmo_dgram_tx *conn, void *data) |
| Set application private data of the datagram transmitter. More... | |
| int | osmo_dgram_tx_open (struct osmo_dgram_tx *conn) |
| Open connection of an Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_close (struct osmo_dgram_tx *conn) |
| Close an Osmocom Datagram Transmitter. More... | |
| void | osmo_dgram_tx_send (struct osmo_dgram_tx *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom datagram transmitter. More... | |
| struct osmo_dgram_rx * | osmo_dgram_rx_create (void *ctx) |
| Create an Osmocom datagram receiver. More... | |
| void | osmo_dgram_rx_set_addr (struct osmo_dgram_rx *conn, const char *addr) |
| Set the local address to which we bind. More... | |
| void | osmo_dgram_rx_set_port (struct osmo_dgram_rx *conn, uint16_t port) |
| Set the local port to which we bind. More... | |
| void | osmo_dgram_rx_set_read_cb (struct osmo_dgram_rx *conn, int(*read_cb)(struct osmo_dgram_rx *conn)) |
| Set the read() call-back of the datagram receiver. More... | |
| void | osmo_dgram_rx_destroy (struct osmo_dgram_rx *conn) |
| Destroy the datagram receiver. More... | |
| int | osmo_dgram_rx_open (struct osmo_dgram_rx *conn) |
| Open the datagram receiver. More... | |
| void | osmo_dgram_rx_close (struct osmo_dgram_rx *conn) |
| Close the datagram receiver and unregister from select loop Does not destroy the datagram receiver, merely closes it! More... | |
| int | osmo_dgram_rx_recv (struct osmo_dgram_rx *conn, struct msgb *msg) |
| Receive data via Osmocom datagram receiver. More... | |
| struct osmo_dgram * | osmo_dgram_create (void *ctx) |
| Create an Osmocom datagram transceiver (bidirectional) More... | |
| void | osmo_dgram_destroy (struct osmo_dgram *conn) |
| Destroy a Osmocom datagram transceiver. More... | |
| int | osmo_dgram_open (struct osmo_dgram *conn) |
| Open the datagram transceiver. More... | |
| void | osmo_dgram_close (struct osmo_dgram *conn) |
| Close an Osmocom Datagram Transceiver. More... | |
| void | osmo_dgram_set_local_addr (struct osmo_dgram *conn, const char *addr) |
| Set the local address to which we bind. More... | |
| void | osmo_dgram_set_remote_addr (struct osmo_dgram *conn, const char *addr) |
| Set the remote address to which we transmit/connect. More... | |
| void | osmo_dgram_set_local_port (struct osmo_dgram *conn, uint16_t port) |
| Set the local port to which we bind. More... | |
| void | osmo_dgram_set_remote_port (struct osmo_dgram *conn, uint16_t port) |
| Set the remote port to which we transmit. More... | |
| void | osmo_dgram_set_read_cb (struct osmo_dgram *conn, int(*read_cb)(struct osmo_dgram *conn)) |
| Set the read() call-back of the datagram receiver. More... | |
| void | osmo_dgram_set_data (struct osmo_dgram *conn, void *data) |
| Set application private data of the datagram transmitter. More... | |
| void * | osmo_dgram_get_data (struct osmo_dgram *conn) |
| Get application private data of the datagram transceiver. More... | |
| void | osmo_dgram_send (struct osmo_dgram *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom datagram transceiver. More... | |
| int | osmo_dgram_recv (struct osmo_dgram *conn, struct msgb *msg) |
| Receive data via Osmocom datagram transceiver. More... | |
This code is intended to abstract any use of datagram type sockets, such as UDP.
It offers both transmitter and receiver side implementations, fully integrated with the libosmocore select loop abstraction.
| void osmo_dgram_close | ( | struct osmo_dgram * | conn | ) |
Close an Osmocom Datagram Transceiver.
| [in] | conn | Osmocom Datagram Transceiver to be closed We unregister the socket fds from the osmocom select() loop and close them. |
References osmo_dgram_rx_close(), and osmo_dgram_tx_close().
| struct osmo_dgram * osmo_dgram_create | ( | void * | ctx | ) |
Create an Osmocom datagram transceiver (bidirectional)
| [in] | ctx | talloc context from which to allocate memory This function allocates a new osmo_dgram and initializes it with default values. Internally, the Transceiver is based on a tuple of transmitter (osmo_dgram_tx) and receiver (osmo_dgram_rx) |
References osmo_dgram_rx_create(), and osmo_dgram_rx_set_read_cb().
| void osmo_dgram_destroy | ( | struct osmo_dgram * | conn | ) |
Destroy a Osmocom datagram transceiver.
| [in] | conn | Datagram Transceiver to destroy |
References osmo_dgram_rx_destroy(), and osmo_dgram_tx_destroy().
| void * osmo_dgram_get_data | ( | struct osmo_dgram * | conn | ) |
Get application private data of the datagram transceiver.
| [in] | conn | Datagram Transceiver |
| int osmo_dgram_open | ( | struct osmo_dgram * | conn | ) |
Open the datagram transceiver.
This actually initializes the underlying sockets and binds/connects them to the configured ips/ports
| [in] | conn | Datagram Transceiver to open |
References osmo_dgram_rx_close(), osmo_dgram_rx_open(), and osmo_dgram_tx_open().
| int osmo_dgram_recv | ( | struct osmo_dgram * | conn, |
| struct msgb * | msg | ||
| ) |
Receive data via Osmocom datagram transceiver.
| [in] | conn | Datagram Transceiver from which to receive |
| msg | pre-allocate message buffer to which received data is appended |
References osmo_dgram_rx_recv().
| void osmo_dgram_rx_close | ( | struct osmo_dgram_rx * | conn | ) |
Close the datagram receiver and unregister from select loop Does not destroy the datagram receiver, merely closes it!
| [in] | conn | Stream Server Link to close |
Referenced by osmo_dgram_close(), osmo_dgram_open(), and osmo_dgram_rx_destroy().
| struct osmo_dgram_rx * osmo_dgram_rx_create | ( | void * | ctx | ) |
Create an Osmocom datagram receiver.
| [in] | ctx | talloc context from which to allocate memory This function allocates a new osmo_dgram_rx and initializes it with default values |
Referenced by osmo_dgram_create().
| void osmo_dgram_rx_destroy | ( | struct osmo_dgram_rx * | conn | ) |
Destroy the datagram receiver.
Releases Memory.
| [in] | conn | Datagram Receiver |
References osmo_dgram_rx_close().
Referenced by osmo_dgram_destroy().
| int osmo_dgram_rx_open | ( | struct osmo_dgram_rx * | conn | ) |
Open the datagram receiver.
This actually initializes the underlying socket and binds it to the configured ip/port
| [in] | conn | Datagram Receiver to open |
Referenced by osmo_dgram_open().
| int osmo_dgram_rx_recv | ( | struct osmo_dgram_rx * | conn, |
| struct msgb * | msg | ||
| ) |
Receive data via Osmocom datagram receiver.
| [in] | conn | Datagram Receiver from which to receive |
| msg | pre-allocate message buffer to which received data is appended |
Referenced by osmo_dgram_recv().
| void osmo_dgram_rx_set_addr | ( | struct osmo_dgram_rx * | conn, |
| const char * | addr | ||
| ) |
Set the local address to which we bind.
| [in] | conn | Datagram Receiver to modify |
| [in] | addr | Local IP address |
Referenced by osmo_dgram_set_local_addr().
| void osmo_dgram_rx_set_port | ( | struct osmo_dgram_rx * | conn, |
| uint16_t | port | ||
| ) |
Set the local port to which we bind.
| [in] | conn | Datagram Receiver to modify |
| [in] | port | Local port number |
Referenced by osmo_dgram_set_local_port().
| void osmo_dgram_rx_set_read_cb | ( | struct osmo_dgram_rx * | conn, |
| int(*)(struct osmo_dgram_rx *conn) | read_cb | ||
| ) |
Set the read() call-back of the datagram receiver.
| [in] | conn | Datagram Receiver to modify |
| [in] | read_cb | Call-back function executed after read() |
Referenced by osmo_dgram_create().
| void osmo_dgram_send | ( | struct osmo_dgram * | conn, |
| struct msgb * | msg | ||
| ) |
Enqueue data to be sent via an Osmocom datagram transceiver.
| [in] | conn | Datagram Transceiver through which we want to send |
| [in] | msg | Message buffer to enqueue in transmit queue |
References osmo_dgram_tx_send().
| void osmo_dgram_set_data | ( | struct osmo_dgram * | conn, |
| void * | data | ||
| ) |
Set application private data of the datagram transmitter.
| [in] | conn | Datagram Transmitter to modify |
| [in] | data | User-specific data (available in call-back functions) |
| void osmo_dgram_set_local_addr | ( | struct osmo_dgram * | conn, |
| const char * | addr | ||
| ) |
Set the local address to which we bind.
| [in] | conn | Datagram Transceiver to modify |
| [in] | addr | Local IP address |
References osmo_dgram_rx_set_addr().
| void osmo_dgram_set_local_port | ( | struct osmo_dgram * | conn, |
| uint16_t | port | ||
| ) |
Set the local port to which we bind.
| [in] | conn | Datagram Transceiver to modify |
| [in] | port | Local Port Number |
References osmo_dgram_rx_set_port().
| void osmo_dgram_set_read_cb | ( | struct osmo_dgram * | conn, |
| int(*)(struct osmo_dgram *conn) | read_cb | ||
| ) |
Set the read() call-back of the datagram receiver.
| [in] | conn | Datagram Receiver to modify |
| [in] | read_cb | Call-back function executed after read() |
| void osmo_dgram_set_remote_addr | ( | struct osmo_dgram * | conn, |
| const char * | addr | ||
| ) |
Set the remote address to which we transmit/connect.
| [in] | conn | Datagram Transceiver to modify |
| [in] | addr | Remote IP address |
References osmo_dgram_tx_set_addr().
| void osmo_dgram_set_remote_port | ( | struct osmo_dgram * | conn, |
| uint16_t | port | ||
| ) |
Set the remote port to which we transmit.
| [in] | conn | Datagram Transceiver to modify |
| [in] | port | Remote Port Number |
References osmo_dgram_tx_set_port().
| void osmo_dgram_tx_close | ( | struct osmo_dgram_tx * | conn | ) |
Close an Osmocom Datagram Transmitter.
| [in] | conn | Osmocom Datagram Transmitter to be closed We unregister the socket fd from the osmocom select() loop abstraction and close the socket |
Referenced by osmo_dgram_close(), and osmo_dgram_tx_destroy().
| struct osmo_dgram_tx * osmo_dgram_tx_create | ( | void * | ctx | ) |
Create an Osmocom datagram transmitter.
| [in] | ctx | talloc context from which to allocate memory This function allocates a new osmo_dgram_tx and initializes it with default values |
| void osmo_dgram_tx_destroy | ( | struct osmo_dgram_tx * | conn | ) |
Destroy a Osmocom datagram transmitter.
| [in] | conn | Datagram Transmitter to destroy |
References osmo_dgram_tx_close().
Referenced by osmo_dgram_destroy().
| int osmo_dgram_tx_open | ( | struct osmo_dgram_tx * | conn | ) |
Open connection of an Osmocom datagram transmitter.
| [in] | conn | Stream Client to connect |
Referenced by osmo_dgram_open().
| void osmo_dgram_tx_send | ( | struct osmo_dgram_tx * | conn, |
| struct msgb * | msg | ||
| ) |
Enqueue data to be sent via an Osmocom datagram transmitter.
| [in] | conn | Datagram Transmitter through which we want to send |
| [in] | msg | Message buffer to enqueue in transmit queue |
Referenced by osmo_dgram_send().
| void osmo_dgram_tx_set_addr | ( | struct osmo_dgram_tx * | conn, |
| const char * | addr | ||
| ) |
Set the remote address to which we transmit.
| [in] | conn | Datagram Transmitter to modify |
| [in] | addr | Remote IP address |
Referenced by osmo_dgram_set_remote_addr().
| void osmo_dgram_tx_set_data | ( | struct osmo_dgram_tx * | conn, |
| void * | data | ||
| ) |
Set application private data of the datagram transmitter.
| [in] | conn | Datagram Transmitter to modify |
| [in] | data | User-specific data (available in call-back functions) |
| void osmo_dgram_tx_set_local_addr | ( | struct osmo_dgram_tx * | conn, |
| const char * | addr | ||
| ) |
Set the local address from which we transmit.
| [in] | conn | Datagram Transmitter to modify |
| [in] | addr | Local IP address |
| void osmo_dgram_tx_set_local_port | ( | struct osmo_dgram_tx * | conn, |
| uint16_t | port | ||
| ) |
Set the local port from which we transmit.
| [in] | conn | Datagram Transmitter to modify |
| [in] | port | Local Port Number |
| void osmo_dgram_tx_set_port | ( | struct osmo_dgram_tx * | conn, |
| uint16_t | port | ||
| ) |
Set the remote port to which we transmit.
| [in] | conn | Datagram Transmitter to modify |
| [in] | port | Remote Port Number |
Referenced by osmo_dgram_set_remote_port().
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint16_t | sequence |
| uint32_t | timestamp |
| uint32_t | ssrc |
| uint8_t | data [0] |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom datagram socket helpers. More...
#include <stdio.h>#include <unistd.h>#include <stdlib.h>#include <errno.h>#include <string.h>#include <time.h>#include <sys/fcntl.h>#include <sys/socket.h>#include <sys/ioctl.h>#include <arpa/inet.h>#include <netinet/in.h>#include <osmocom/core/linuxlist.h>#include <osmocom/core/select.h>#include <osmocom/core/utils.h>#include <osmocom/gsm/tlv.h>#include <osmocom/core/msgb.h>#include <osmocom/core/logging.h>#include <osmocom/core/talloc.h>#include <osmocom/core/socket.h>#include <osmocom/netif/datagram.h>Macros | |
| #define | OSMO_DGRAM_CLI_F_RECONF (1 << 0) |
| #define | OSMO_DGRAM_RX_F_RECONF (1 << 0) |
Functions | |
| void | osmo_dgram_tx_close (struct osmo_dgram_tx *conn) |
| Close an Osmocom Datagram Transmitter. More... | |
| struct osmo_dgram_tx * | osmo_dgram_tx_create (void *ctx) |
| Create an Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_set_addr (struct osmo_dgram_tx *conn, const char *addr) |
| Set the remote address to which we transmit. More... | |
| void | osmo_dgram_tx_set_port (struct osmo_dgram_tx *conn, uint16_t port) |
| Set the remote port to which we transmit. More... | |
| void | osmo_dgram_tx_set_local_addr (struct osmo_dgram_tx *conn, const char *addr) |
| Set the local address from which we transmit. More... | |
| void | osmo_dgram_tx_set_local_port (struct osmo_dgram_tx *conn, uint16_t port) |
| Set the local port from which we transmit. More... | |
| void | osmo_dgram_tx_set_data (struct osmo_dgram_tx *conn, void *data) |
| Set application private data of the datagram transmitter. More... | |
| void | osmo_dgram_tx_destroy (struct osmo_dgram_tx *conn) |
| Destroy a Osmocom datagram transmitter. More... | |
| int | osmo_dgram_tx_open (struct osmo_dgram_tx *conn) |
| Open connection of an Osmocom datagram transmitter. More... | |
| void | osmo_dgram_tx_send (struct osmo_dgram_tx *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom datagram transmitter. More... | |
| int | osmo_dgram_rx_recv (struct osmo_dgram_rx *conn, struct msgb *msg) |
| Receive data via Osmocom datagram receiver. More... | |
| struct osmo_dgram_rx * | osmo_dgram_rx_create (void *ctx) |
| Create an Osmocom datagram receiver. More... | |
| void | osmo_dgram_rx_set_addr (struct osmo_dgram_rx *conn, const char *addr) |
| Set the local address to which we bind. More... | |
| void | osmo_dgram_rx_set_port (struct osmo_dgram_rx *conn, uint16_t port) |
| Set the local port to which we bind. More... | |
| void | osmo_dgram_rx_set_read_cb (struct osmo_dgram_rx *conn, int(*read_cb)(struct osmo_dgram_rx *conn)) |
| Set the read() call-back of the datagram receiver. More... | |
| void | osmo_dgram_rx_destroy (struct osmo_dgram_rx *conn) |
| Destroy the datagram receiver. More... | |
| int | osmo_dgram_rx_open (struct osmo_dgram_rx *conn) |
| Open the datagram receiver. More... | |
| void | osmo_dgram_rx_close (struct osmo_dgram_rx *conn) |
| Close the datagram receiver and unregister from select loop Does not destroy the datagram receiver, merely closes it! More... | |
| struct osmo_dgram * | osmo_dgram_create (void *ctx) |
| Create an Osmocom datagram transceiver (bidirectional) More... | |
| void | osmo_dgram_destroy (struct osmo_dgram *conn) |
| Destroy a Osmocom datagram transceiver. More... | |
| void | osmo_dgram_set_local_addr (struct osmo_dgram *conn, const char *addr) |
| Set the local address to which we bind. More... | |
| void | osmo_dgram_set_remote_addr (struct osmo_dgram *conn, const char *addr) |
| Set the remote address to which we transmit/connect. More... | |
| void | osmo_dgram_set_local_port (struct osmo_dgram *conn, uint16_t port) |
| Set the local port to which we bind. More... | |
| void | osmo_dgram_set_remote_port (struct osmo_dgram *conn, uint16_t port) |
| Set the remote port to which we transmit. More... | |
| void | osmo_dgram_set_read_cb (struct osmo_dgram *conn, int(*read_cb)(struct osmo_dgram *conn)) |
| Set the read() call-back of the datagram receiver. More... | |
| void | osmo_dgram_set_data (struct osmo_dgram *conn, void *data) |
| Set application private data of the datagram transmitter. More... | |
| void * | osmo_dgram_get_data (struct osmo_dgram *conn) |
| Get application private data of the datagram transceiver. More... | |
| int | osmo_dgram_open (struct osmo_dgram *conn) |
| Open the datagram transceiver. More... | |
| void | osmo_dgram_close (struct osmo_dgram *conn) |
| Close an Osmocom Datagram Transceiver. More... | |
| void | osmo_dgram_send (struct osmo_dgram *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom datagram transceiver. More... | |
| int | osmo_dgram_recv (struct osmo_dgram *conn, struct msgb *msg) |
| Receive data via Osmocom datagram transceiver. More... | |
Osmocom datagram socket helpers.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom multiplex protocol helpers (input) More...
#include <stdio.h>#include <string.h>#include <inttypes.h>#include <osmocom/core/msgb.h>#include <osmocom/core/timer.h>#include <osmocom/core/timer_compat.h>#include <osmocom/core/select.h>#include <osmocom/core/talloc.h>#include <osmocom/core/logging.h>#include <osmocom/netif/amr.h>#include <osmocom/netif/rtp.h>#include <osmocom/netif/osmux.h>#include <arpa/inet.h>Macros | |
| #define | DELTA_RTP_MSG 20000 |
| #define | DELTA_RTP_TIMESTAMP 160 |
| #define | LOGMUXLK_(link, lvl, fmt, args ...) |
| #define | LOGMUXLK(link, lvl, fmt, args ...) LOGMUXLK_(link, lvl, " " fmt, ## args) |
| #define | LOGMUXCID(link, circuit, lvl, fmt, args ...) |
Functions | |
| void | osmux_xfrm_input_deliver (struct osmux_in_handle *h) |
| int | osmux_xfrm_input (struct osmux_in_handle *h, struct msgb *msg, int ccid) |
| osmux_xfrm_input - add RTP message to OSmux batch More... | |
| struct osmux_in_handle * | osmux_xfrm_input_alloc (void *ctx) |
| Allocate a new osmux in handle (osmux source, tx side) More... | |
| void | osmux_xfrm_input_init (struct osmux_in_handle *h) OSMO_DEPRECATED("Use osmux_xfrm_input_alloc() instead") |
| int | osmux_xfrm_input_set_batch_factor (struct osmux_in_handle *h, uint8_t batch_factor) |
| void | osmux_xfrm_input_set_batch_size (struct osmux_in_handle *h, uint16_t batch_size) |
| void | osmux_xfrm_input_set_initial_seqnum (struct osmux_in_handle *h, uint8_t osmux_seqnum) |
| void | osmux_xfrm_input_set_deliver_cb (struct osmux_in_handle *h, void(*deliver_cb)(struct msgb *msg, void *data), void *data) |
| void * | osmux_xfrm_input_get_deliver_cb_data (struct osmux_in_handle *h) |
| void | osmux_xfrm_input_set_name (struct osmux_in_handle *h, const char *name) |
| int | osmux_xfrm_input_open_circuit (struct osmux_in_handle *h, int ccid, int dummy) |
| void | osmux_xfrm_input_close_circuit (struct osmux_in_handle *h, int ccid) |
| void | osmux_xfrm_input_fini (struct osmux_in_handle *h) OSMO_DEPRECATED("Use talloc_free() instead") |
Osmocom multiplex protocol helpers (input)
| #define LOGMUXCID | ( | link, | |
| circuit, | |||
| lvl, | |||
| fmt, | |||
| args ... | |||
| ) |
| #define LOGMUXLK_ | ( | link, | |
| lvl, | |||
| fmt, | |||
| args ... | |||
| ) |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint16_t | by_profile |
| uint16_t | length |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom multiplex protocol helpers. More...
#include <stdio.h>#include <string.h>#include <osmocom/core/msgb.h>#include <osmocom/core/timer.h>#include <osmocom/core/timer_compat.h>#include <osmocom/core/select.h>#include <osmocom/core/talloc.h>#include <osmocom/core/logging.h>#include <osmocom/netif/amr.h>#include <osmocom/netif/rtp.h>#include <osmocom/netif/osmux.h>#include <arpa/inet.h>Macros | |
| #define | SNPRINTF_BUFFER_SIZE(ret, remain, offset) |
Functions | |
| int | osmux_snprintf (char *buf, size_t size, struct msgb *msg) |
| Print osmux header fields and payload from msg into buffer buf. More... | |
Osmocom multiplex protocol helpers.
| #define SNPRINTF_BUFFER_SIZE | ( | ret, | |
| remain, | |||
| offset | |||
| ) |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
This code implements a variety of utility functions related to the OSMUX user-plane multiplexing protocol, an efficient alternative to plain UDP/RTP streams for voice transport in back-haul of cellular networks. More...
Files | |
| file | osmux.h |
| Osmocom multiplex protocol helpers. | |
| file | osmux.c |
| Osmocom multiplex protocol helpers. | |
| file | osmux_input.c |
| Osmocom multiplex protocol helpers (input) | |
| file | osmux_output.c |
| Osmocom multiplex protocol helpers (output) | |
Data Structures | |
| struct | osmux_hdr |
| Osmux protocol header. More... | |
| struct | osmux_in_handle |
| one to handle all existing RTP flows More... | |
| struct | osmux_out_handle |
| one per OSmux circuit_id, ie. More... | |
Macros | |
| #define | OSMUX_DEFAULT_PORT 1984 |
| #define | OSMUX_FT_SIGNAL 0 |
| #define | OSMUX_FT_VOICE_AMR 1 |
| #define | OSMUX_FT_DUMMY 2 |
| #define | OSMUX_MAX_CONCURRENT_CALLS 8 |
| #define | OSMUX_BATCH_DEFAULT_MAX 1472 |
Typedefs | |
| typedef struct msgb *(* | rtp_msgb_alloc_cb_t) (void *rtp_msgb_alloc_priv_data, unsigned int msg_len) |
Functions | |
| struct osmux_hdr | __attribute__ ((packed)) |
| int | osmux_snprintf (char *buf, size_t size, struct msgb *msg) |
| Print osmux header fields and payload from msg into buffer buf. More... | |
| struct osmux_in_handle * | osmux_xfrm_input_alloc (void *ctx) |
| Allocate a new osmux in handle (osmux source, tx side) More... | |
| void | osmux_xfrm_input_init (struct osmux_in_handle *h) OSMO_DEPRECATED("Use osmux_xfrm_input_alloc() instead") |
| void | osmux_xfrm_input_fini (struct osmux_in_handle *h) OSMO_DEPRECATED("Use talloc_free() instead") |
| void | osmux_xfrm_input_set_name (struct osmux_in_handle *h, const char *name) |
| int | osmux_xfrm_input_set_batch_factor (struct osmux_in_handle *h, uint8_t batch_factor) |
| void | osmux_xfrm_input_set_batch_size (struct osmux_in_handle *h, uint16_t batch_size) |
| void | osmux_xfrm_input_set_initial_seqnum (struct osmux_in_handle *h, uint8_t osmux_seqnum) |
| void | osmux_xfrm_input_set_deliver_cb (struct osmux_in_handle *h, void(*deliver_cb)(struct msgb *msg, void *data), void *data) |
| void * | osmux_xfrm_input_get_deliver_cb_data (struct osmux_in_handle *h) |
| int | osmux_xfrm_input_open_circuit (struct osmux_in_handle *h, int ccid, int dummy) |
| void | osmux_xfrm_input_close_circuit (struct osmux_in_handle *h, int ccid) |
| int | osmux_xfrm_input (struct osmux_in_handle *h, struct msgb *msg, int ccid) |
| osmux_xfrm_input - add RTP message to OSmux batch More... | |
| void | osmux_xfrm_input_deliver (struct osmux_in_handle *h) |
| struct osmux_out_handle * | osmux_xfrm_output_alloc (void *ctx) |
| Allocate a new osmux out handle. More... | |
| void | osmux_xfrm_output_init (struct osmux_out_handle *h, uint32_t rtp_ssrc) OSMO_DEPRECATED("Use osmux_xfrm_output_alloc() and osmux_xfrm_output_set_rtp_*() instead") |
| void | osmux_xfrm_output_init2 (struct osmux_out_handle *h, uint32_t rtp_ssrc, uint8_t rtp_payload_type) OSMO_DEPRECATED("Use osmux_xfrm_output_alloc() and osmux_xfrm_output_set_rtp_*() instead") |
| void | osmux_xfrm_output_set_rtp_ssrc (struct osmux_out_handle *h, uint32_t rtp_ssrc) |
| Set SSRC of generated RTP packets from Osmux frames. More... | |
| void | osmux_xfrm_output_set_rtp_pl_type (struct osmux_out_handle *h, uint32_t rtp_payload_type) |
| Set Payload Type of generated RTP packets from Osmux frames. More... | |
| void | osmux_xfrm_output_set_tx_cb (struct osmux_out_handle *h, void(*tx_cb)(struct msgb *msg, void *data), void *data) |
| Set transmission callback to call when a generated RTP packet is to be transmitted. More... | |
| void | osmux_xfrm_output_set_rtp_msgb_alloc_cb (struct osmux_out_handle *h, rtp_msgb_alloc_cb_t cb, void *cb_data) |
| Set callback to call when an RTP packet to be generated is to be allocated. More... | |
| int | osmux_xfrm_output_sched (struct osmux_out_handle *h, struct osmux_hdr *osmuxh) |
| Generate RTP packets from osmux frame AMR payload set and schedule them for transmission at appropriate time. More... | |
| void | osmux_xfrm_output_flush (struct osmux_out_handle *h) |
| Flush all scheduled RTP packets still pending to be transmitted. More... | |
| struct osmux_hdr * | osmux_xfrm_output_pull (struct msgb *msg) |
Variables | |
| struct osmux_in_handle | __attribute__ |
This code implements a variety of utility functions related to the OSMUX user-plane multiplexing protocol, an efficient alternative to plain UDP/RTP streams for voice transport in back-haul of cellular networks.
For information about the OSMUX protocol design, please see the OSMUX reference manual at http://ftp.osmocom.org/docs/latest/osmux-reference.pdf
| int osmux_snprintf | ( | char * | buf, |
| size_t | size, | ||
| struct msgb * | msg | ||
| ) |
Print osmux header fields and payload from msg into buffer buf.
| [out] | buf | buffer to store the output into |
| [in] | len | length of buf in bytes |
| [in] | msgb | message buffer containing one or more osmux frames |
If the output was truncated due to this limit, then the return value is the number of characters (excluding the terminating null byte) which would have been written to the final string if enough space had been available.
| int osmux_xfrm_input | ( | struct osmux_in_handle * | h, |
| struct msgb * | msg, | ||
| int | ccid | ||
| ) |
osmux_xfrm_input - add RTP message to OSmux batch
| msg | RTP message that you want to batch into one OSmux message |
If 0 is returned, this indicates that the message has been batched and the msgb is now owned by the osmux layer. If negative value is returned, an error occurred and the message has been dropped (and freed). If 1 is returned, you have to invoke osmux_xfrm_input_deliver and try again.
The function takes care of releasing the messages in case of error and when building the batch.
| struct osmux_in_handle * osmux_xfrm_input_alloc | ( | void * | ctx | ) |
Allocate a new osmux in handle (osmux source, tx side)
| [in] | ctx | talloc context to use when allocating the returned struct |
This object contains configuration and state to handle a group of circuits (trunk), receiving RTP packets from the upper layer (API user) and sending batched & trunked Osmux messages containing all the data of those circuits down the stack outgoing network Osmux messages. Returned pointer can be freed with regular talloc_free, all pending messages in queue and all internal data will be freed.
| void osmux_xfrm_input_fini | ( | struct osmux_in_handle * | h | ) |
| void osmux_xfrm_input_init | ( | struct osmux_in_handle * | h | ) |
| struct osmux_out_handle * osmux_xfrm_output_alloc | ( | void * | ctx | ) |
Allocate a new osmux out handle.
| [in] | ctx | talloc context to use when allocating the returned struct |
This object contains configuration and state to handle a specific CID in incoming network Osmux messages, repackaging the frames for that CID as RTP packets and pushing them up the protocol stack. Returned pointer can be freed with regular talloc_free, queue will be flushed and all internal data will be freed.
| void osmux_xfrm_output_flush | ( | struct osmux_out_handle * | h | ) |
Flush all scheduled RTP packets still pending to be transmitted.
| [in] | h | the osmux out handle to flush |
This function will immediately call the transmit callback for all queued RTP packets, making sure the list ends up empty. It will also stop all internal timers to make sure the osmux_out_handle can be dropped or re-used by calling osmux_xfrm_output on it.
| void osmux_xfrm_output_init | ( | struct osmux_out_handle * | h, |
| uint32_t | rtp_ssrc | ||
| ) |
| void osmux_xfrm_output_init2 | ( | struct osmux_out_handle * | h, |
| uint32_t | rtp_ssrc, | ||
| uint8_t | rtp_payload_type | ||
| ) |
| int osmux_xfrm_output_sched | ( | struct osmux_out_handle * | h, |
| struct osmux_hdr * | osmuxh | ||
| ) |
Generate RTP packets from osmux frame AMR payload set and schedule them for transmission at appropriate time.
| [in] | h | the osmux out handle handling a specific CID |
| [in] | osmuxh | Buffer pointing to osmux frame header structure and AMR payload |
The osmux frame passed to this function must be of the type OSMUX_FT_VOICE_AMR. The generated RTP packets are kept into h's internal list and sent to the callback configured through osmux_xfrm_output_set_tx_cb when are ready to be transmitted according to schedule.
| void osmux_xfrm_output_set_rtp_msgb_alloc_cb | ( | struct osmux_out_handle * | h, |
| rtp_msgb_alloc_cb_t | cb, | ||
| void * | cb_data | ||
| ) |
Set callback to call when an RTP packet to be generated is to be allocated.
| [in] | h | the osmux out handle handling a specific CID |
| [in] | cb | User defined msgb alloc function for generated RTP pkts |
| [in] | cb_data | Opaque data pointer set by user and passed in cb |
| void osmux_xfrm_output_set_rtp_pl_type | ( | struct osmux_out_handle * | h, |
| uint32_t | rtp_payload_type | ||
| ) |
Set Payload Type of generated RTP packets from Osmux frames.
| [in] | h | the osmux out handle handling a specific CID |
| [in] | rtp_payload_type | the RTP Payload Type to set |
| void osmux_xfrm_output_set_rtp_ssrc | ( | struct osmux_out_handle * | h, |
| uint32_t | rtp_ssrc | ||
| ) |
Set SSRC of generated RTP packets from Osmux frames.
| [in] | h | the osmux out handle handling a specific CID |
| [in] | rtp_ssrc | the RTP SSRC to set |
| void osmux_xfrm_output_set_tx_cb | ( | struct osmux_out_handle * | h, |
| void(*)(struct msgb *msg, void *data) | tx_cb, | ||
| void * | data | ||
| ) |
Set transmission callback to call when a generated RTP packet is to be transmitted.
| [in] | h | the osmux out handle handling a specific CID |
| [in] | osmuxh | Buffer pointing to osmux frame header structure and AMR payload |
This Function sets the callback called by the interal timer set by osmux_xfrm_out_sched function.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
| Camr_hdr | |
| Camr_hdr_bwe | |
| Cipa_head | |
| Cipa_head_ext | |
| Cosmo_ipa_msgb_cb | |
| Cosmo_jibuf | A structure representing a single instance of a jitter buffer |
| Cosmux_hdr | Osmux protocol header |
| Cosmux_in_handle | One to handle all existing RTP flows |
| Cosmux_out_handle | One per OSmux circuit_id, ie |
| Crtcp_hdr | |
| Crtp_hdr | |
| Crtp_x_hdr |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom Jitter Buffer helpers. More...
#include <stdio.h>#include <string.h>#include <inttypes.h>#include <osmocom/core/msgb.h>#include <osmocom/core/timer.h>#include <osmocom/core/talloc.h>#include <osmocom/core/logging.h>#include <osmocom/core/utils.h>#include <osmocom/netif/amr.h>#include <osmocom/netif/rtp.h>#include <osmocom/netif/jibuf.h>#include <arpa/inet.h>Functions | |
| struct osmo_jibuf * | osmo_jibuf_alloc (void *talloc_ctx) |
| Allocate a new jitter buffer instance. More... | |
| void | osmo_jibuf_delete (struct osmo_jibuf *jb) |
| Destroy a previously allocated jitter buffer instance. More... | |
| int | osmo_jibuf_enqueue (struct osmo_jibuf *jb, struct msgb *msg) |
| Try to enqueue a packet into the jitter buffer. More... | |
| bool | osmo_jibuf_empty (struct osmo_jibuf *jb) |
| Check whether the jitter buffer instance has packets queued or not. More... | |
| void | osmo_jibuf_set_min_delay (struct osmo_jibuf *jb, uint32_t min_delay) |
| Set minimum buffer size for the jitter buffer. More... | |
| void | osmo_jibuf_set_max_delay (struct osmo_jibuf *jb, uint32_t max_delay) |
| Set maximum buffer size for the jitter buffer. More... | |
| void | osmo_jibuf_enable_skew_compensation (struct osmo_jibuf *jb, bool enable) |
| Toggle use of skew detection and compensation mechanism. More... | |
| void | osmo_jibuf_set_dequeue_cb (struct osmo_jibuf *jb, osmo_jibuf_dequeue_cb dequeue_cb, void *cb_data) |
| Set dequeue callback for the jitter buffer. More... | |
Osmocom Jitter Buffer helpers.
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint8_t | proto |
| uint8_t | data [0] |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
one to handle all existing RTP flows More...
#include <osmux.h>
one to handle all existing RTP flows
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
#include <stdbool.h>#include <stdint.h>#include <unistd.h>#include <osmocom/core/msgb.h>Go to the source code of this file.
Typedefs | |
| typedef int(* | osmo_stream_srv_link_accept_cb_t) (struct osmo_stream_srv_link *link, int fd) |
| typedef int(* | osmo_stream_srv_read_cb_t) (struct osmo_stream_srv *conn) |
| typedef int(* | osmo_stream_srv_closed_cb_t) (struct osmo_stream_srv *conn) |
| typedef 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. More... | |
| typedef int(* | osmo_stream_srv_segmentation_cb_t) (struct msgb *msg) |
| typedef int(* | osmo_stream_cli_connect_cb_t) (struct osmo_stream_cli *cli) |
| typedef int(* | osmo_stream_cli_disconnect_cb_t) (struct osmo_stream_cli *cli) |
| typedef int(* | osmo_stream_cli_read_cb_t) (struct osmo_stream_cli *cli) |
| typedef 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. More... | |
| typedef int(* | osmo_stream_cli_segmentation_cb_t) (struct msgb *msg) |
Functions | |
| struct osmo_stream_srv_link * | osmo_stream_srv_link_create (void *ctx) |
| Create an Osmocom Stream Server Link. More... | |
| void | osmo_stream_srv_link_destroy (struct osmo_stream_srv_link *link) |
| Destroy the stream server link. More... | |
| 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). More... | |
| 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()). More... | |
| 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. More... | |
| int | osmo_stream_srv_link_set_priority (struct osmo_stream_srv_link *link, int sk_prio) |
| Set the priority value of the stream socket. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_addr (struct osmo_stream_srv_link *link, const char *addr) |
| Set the local address to which we bind. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_proto (struct osmo_stream_srv_link *link, uint16_t proto) |
| Set the protocol for the stream server link. More... | |
| int | osmo_stream_srv_link_set_type (struct osmo_stream_srv_link *link, int type) |
| Set the socket type for the stream server link. More... | |
| int | osmo_stream_srv_link_set_domain (struct osmo_stream_srv_link *link, int domain) |
| Set the socket type for the stream server link. More... | |
| 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. More... | |
| void | osmo_stream_srv_link_set_data (struct osmo_stream_srv_link *link, void *data) |
| Set application private data of the stream server link. More... | |
| void * | osmo_stream_srv_link_get_data (struct osmo_stream_srv_link *link) |
| Retrieve application private data of the stream server link. More... | |
| 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. More... | |
| char * | osmo_stream_srv_link_get_sockname (const struct osmo_stream_srv_link *link) |
| Retrieve description of the stream server link e. More... | |
| struct osmo_fd * | osmo_stream_srv_link_get_ofd (struct osmo_stream_srv_link *link) |
| Retrieve Osmocom File Descriptor of the stream server link. More... | |
| int | osmo_stream_srv_link_get_fd (const struct osmo_stream_srv_link *link) |
| Retrieve File Descriptor of the stream server link. More... | |
| bool | osmo_stream_srv_link_is_opened (const struct osmo_stream_srv_link *link) |
| Check whether the stream server link is opened. More... | |
| int | osmo_stream_srv_link_open (struct osmo_stream_srv_link *link) |
| Open the stream server link. More... | |
| void | osmo_stream_srv_link_close (struct osmo_stream_srv_link *link) |
| Close the stream server link and unregister from select loop. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_srv_set_name (struct osmo_stream_srv *conn, const char *name) |
| Set a name on the srv object (used during logging). More... | |
| 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()). More... | |
| 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. More... | |
| void | osmo_stream_srv_set_closed_cb (struct osmo_stream_srv *conn, osmo_stream_srv_closed_cb_t closed_cb) |
| Set the call-back function called when the stream server socket was closed. More... | |
| void * | osmo_stream_srv_get_data (struct osmo_stream_srv *conn) |
| Retrieve application private data of the stream server. More... | |
| struct osmo_stream_srv_link * | osmo_stream_srv_get_master (struct osmo_stream_srv *conn) |
| Retrieve the master (Link) from a Stream Server. More... | |
| const char * | osmo_stream_srv_get_sockname (const struct osmo_stream_srv *conn) |
| Retrieve the stream server socket description. More... | |
| struct osmo_fd * | osmo_stream_srv_get_ofd (struct osmo_stream_srv *conn) |
| Retrieve Osmocom File Descriptor of a stream server in osmo_fd mode. More... | |
| int | osmo_stream_srv_get_fd (const struct osmo_stream_srv *conn) |
| Retrieve File Descriptor of the stream server. More... | |
| struct osmo_io_fd * | osmo_stream_srv_get_iofd (const struct osmo_stream_srv *srv) |
| Retrieve osmo_io descriptor of the stream server socket. More... | |
| void | osmo_stream_srv_destroy (struct osmo_stream_srv *conn) |
| Destroy given Stream Server. More... | |
| 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. More... | |
| void | osmo_stream_srv_set_data (struct osmo_stream_srv *conn, void *data) |
| Set application private data of the stream server. More... | |
| 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. More... | |
| void | osmo_stream_srv_send (struct osmo_stream_srv *conn, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom stream server. More... | |
| int | osmo_stream_srv_recv (struct osmo_stream_srv *conn, struct msgb *msg) |
| Receive data via an Osmocom stream server in osmo_fd mode. More... | |
| void | osmo_stream_srv_clear_tx_queue (struct osmo_stream_srv *conn) |
| void | osmo_stream_cli_set_name (struct osmo_stream_cli *cli, const char *name) |
| Set a name on the cli object (used during logging). More... | |
| 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()). More... | |
| void | osmo_stream_cli_set_nodelay (struct osmo_stream_cli *cli, bool nodelay) |
| Set the NODELAY socket option to avoid Nagle-like behavior. More... | |
| int | osmo_stream_cli_set_priority (struct osmo_stream_cli *cli, int sk_prio) |
| Set the priority value of the stream socket. More... | |
| 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. More... | |
| void | osmo_stream_cli_set_addr (struct osmo_stream_cli *cli, const char *addr) |
| Set the remote address to which we connect. More... | |
| 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. More... | |
| void | osmo_stream_cli_set_port (struct osmo_stream_cli *cli, uint16_t port) |
| Set the remote port number to which we connect. More... | |
| int | osmo_stream_cli_set_type (struct osmo_stream_cli *cli, int type) |
| Set the socket type for the stream server link. More... | |
| int | osmo_stream_cli_set_domain (struct osmo_stream_cli *cli, int domain) |
| Set the socket type for the stream server link. More... | |
| void | osmo_stream_cli_set_proto (struct osmo_stream_cli *cli, uint16_t proto) |
| Set the protocol for the stream client socket. More... | |
| 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). More... | |
| 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. More... | |
| 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). More... | |
| void | osmo_stream_cli_set_data (struct osmo_stream_cli *cli, void *data) |
| Set application private data of the stream client socket. More... | |
| void | osmo_stream_cli_set_reconnect_timeout (struct osmo_stream_cli *cli, int timeout) |
| Set the reconnect time of the stream client socket. More... | |
| void * | osmo_stream_cli_get_data (struct osmo_stream_cli *cli) |
| Retrieve application private data of the stream client socket. More... | |
| 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. More... | |
| char * | osmo_stream_cli_get_sockname (const struct osmo_stream_cli *cli) |
| Retrieve the stream client socket description. More... | |
| struct osmo_fd * | osmo_stream_cli_get_ofd (struct osmo_stream_cli *cli) |
| Retrieve Osmocom File Descriptor of the stream client socket. More... | |
| int | osmo_stream_cli_get_fd (const struct osmo_stream_cli *cli) |
| Retrieve file descriptor of the stream client socket. More... | |
| struct osmo_io_fd * | osmo_stream_cli_get_iofd (const struct osmo_stream_cli *cli) |
| Retrieve osmo_io descriptor of the stream client socket. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| 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. More... | |
| void | osmo_stream_cli_reconnect (struct osmo_stream_cli *cli) |
| Re-connect an Osmocom Stream Client. More... | |
| bool | osmo_stream_cli_is_connected (struct osmo_stream_cli *cli) |
| Check if Osmocom Stream Client is in connected state. More... | |
| struct osmo_stream_cli * | osmo_stream_cli_create (void *ctx) |
| Create an Osmocom stream client. More... | |
| void | osmo_stream_cli_destroy (struct osmo_stream_cli *cli) |
| Destroy a Osmocom stream client (includes close). More... | |
| int | osmo_stream_cli_open (struct osmo_stream_cli *cli) |
| Open connection of an Osmocom stream client. More... | |
| int | osmo_stream_cli_open2 (struct osmo_stream_cli *cli, int reconnect) |
| DEPRECATED: use osmo_stream_cli_set_reconnect_timeout() or osmo_stream_cli_reconnect() instead! Open connection of an Osmocom stream client. More... | |
| void | osmo_stream_cli_close (struct osmo_stream_cli *cli) |
| Close an Osmocom Stream Client. More... | |
| void | osmo_stream_cli_send (struct osmo_stream_cli *cli, struct msgb *msg) |
| Enqueue data to be sent via an Osmocom stream client. More... | |
| int | osmo_stream_cli_recv (struct osmo_stream_cli *cli, struct msgb *msg) |
| Receive data via an Osmocom stream client in osmo_fd mode. More... | |
| void | osmo_stream_cli_clear_tx_queue (struct osmo_stream_cli *cli) |
| Clear the transmit queue of the stream client. More... | |
| 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. More... | |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Data Fields | |
| uint16_t | len |
| uint8_t | proto |
| uint8_t | data [0] |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
| ▼ include | |
| ▼ osmocom | |
| ▼ netif | |
| amr.h | |
| datagram.h | Osmocom datagram socket helpers |
| ipa.h | |
| ipa_unit.h | |
| jibuf.h | Osmocom Jitter Buffer helpers |
| osmux.h | Osmocom multiplex protocol helpers |
| prim.h | |
| rs232.h | |
| rtp.h | |
| sctp.h | |
| stream.h | |
| stream_private.h | |
| ▼ src | |
| datagram.c | Osmocom datagram socket helpers |
| jibuf.c | Osmocom Jitter Buffer helpers |
| osmux.c | Osmocom multiplex protocol helpers |
| osmux_input.c | Osmocom multiplex protocol helpers (input) |
| osmux_output.c | Osmocom multiplex protocol helpers (output) |
| stream_cli.c | |
| stream_srv.c |
1.9.4 |
libosmo-netif 1.5.1.23-95b2
Osmocom network interface library
|
Osmocom multiplex protocol helpers. More...
#include <osmocom/core/endian.h>#include <osmocom/core/timer.h>#include <osmocom/core/msgb.h>Go to the source code of this file.
Data Structures | |
| struct | osmux_hdr |
| Osmux protocol header. More... | |
| struct | osmux_in_handle |
| one to handle all existing RTP flows More... | |
| struct | osmux_out_handle |
| one per OSmux circuit_id, ie. More... | |
Typedefs | |
| typedef struct msgb *(* | rtp_msgb_alloc_cb_t) (void *rtp_msgb_alloc_priv_data, unsigned int msg_len) |
Functions | |
| struct osmux_hdr | __attribute__ ((packed)) |
| int | osmux_snprintf (char *buf, size_t size, struct msgb *msg) |
| Print osmux header fields and payload from msg into buffer buf. More... | |
| struct osmux_in_handle * | osmux_xfrm_input_alloc (void *ctx) |
| Allocate a new osmux in handle (osmux source, tx side) More... | |
| void | osmux_xfrm_input_init (struct osmux_in_handle *h) OSMO_DEPRECATED("Use osmux_xfrm_input_alloc() instead") |
| void | osmux_xfrm_input_fini (struct osmux_in_handle *h) OSMO_DEPRECATED("Use talloc_free() instead") |
| void | osmux_xfrm_input_set_name (struct osmux_in_handle *h, const char *name) |
| int | osmux_xfrm_input_set_batch_factor (struct osmux_in_handle *h, uint8_t batch_factor) |
| void | osmux_xfrm_input_set_batch_size (struct osmux_in_handle *h, uint16_t batch_size) |
| void | osmux_xfrm_input_set_initial_seqnum (struct osmux_in_handle *h, uint8_t osmux_seqnum) |
| void | osmux_xfrm_input_set_deliver_cb (struct osmux_in_handle *h, void(*deliver_cb)(struct msgb *msg, void *data), void *data) |
| void * | osmux_xfrm_input_get_deliver_cb_data (struct osmux_in_handle *h) |
| int | osmux_xfrm_input_open_circuit (struct osmux_in_handle *h, int ccid, int dummy) |
| void | osmux_xfrm_input_close_circuit (struct osmux_in_handle *h, int ccid) |
| int | osmux_xfrm_input (struct osmux_in_handle *h, struct msgb *msg, int ccid) |
| osmux_xfrm_input - add RTP message to OSmux batch More... | |
| void | osmux_xfrm_input_deliver (struct osmux_in_handle *h) |
| struct osmux_out_handle * | osmux_xfrm_output_alloc (void *ctx) |
| Allocate a new osmux out handle. More... | |
| void | osmux_xfrm_output_init (struct osmux_out_handle *h, uint32_t rtp_ssrc) OSMO_DEPRECATED("Use osmux_xfrm_output_alloc() and osmux_xfrm_output_set_rtp_*() instead") |
| void | osmux_xfrm_output_init2 (struct osmux_out_handle *h, uint32_t rtp_ssrc, uint8_t rtp_payload_type) OSMO_DEPRECATED("Use osmux_xfrm_output_alloc() and osmux_xfrm_output_set_rtp_*() instead") |
| void | osmux_xfrm_output_set_rtp_ssrc (struct osmux_out_handle *h, uint32_t rtp_ssrc) |
| Set SSRC of generated RTP packets from Osmux frames. More... | |
| void | osmux_xfrm_output_set_rtp_pl_type (struct osmux_out_handle *h, uint32_t rtp_payload_type) |
| Set Payload Type of generated RTP packets from Osmux frames. More... | |
| void | osmux_xfrm_output_set_tx_cb (struct osmux_out_handle *h, void(*tx_cb)(struct msgb *msg, void *data), void *data) |
| Set transmission callback to call when a generated RTP packet is to be transmitted. More... | |
| void | osmux_xfrm_output_set_rtp_msgb_alloc_cb (struct osmux_out_handle *h, rtp_msgb_alloc_cb_t cb, void *cb_data) |
| Set callback to call when an RTP packet to be generated is to be allocated. More... | |
| int | osmux_xfrm_output_sched (struct osmux_out_handle *h, struct osmux_hdr *osmuxh) |
| Generate RTP packets from osmux frame AMR payload set and schedule them for transmission at appropriate time. More... | |
| void | osmux_xfrm_output_flush (struct osmux_out_handle *h) |
| Flush all scheduled RTP packets still pending to be transmitted. More... | |
| struct osmux_hdr * | osmux_xfrm_output_pull (struct msgb *msg) |
Variables | |
| uint8_t | seq |
| uint8_t | circuit_id |
| uint8_t | data [0] |
| struct osmux_in_handle | __attribute__ |
Osmocom multiplex protocol helpers.
1.9.4