upipe-modules/upipe_udp_sink.h header reference

Upipe sink module for udp More

Header inclusion  

Members  

Type  

Functions  

Description  

Upipe sink module for udp

Members detail  

#define UPIPE_UDPSINK_SIGNATURE  

This macro is declared in upipe-modules/upipe_udp_sink.h source file, line 41.

#define _UPIPE_MODULES_UPIPE_UDP_SINK_H_  

This macro is declared in upipe-modules/upipe_udp_sink.h source file, line 32.

enum upipe_udpsink_command  

This enum is declared in upipe-modules/upipe_udp_sink.h source file, line 45.

This enum extends upipe_command with specific commands for udp sink.

IdentifierValueDescription
UPIPE_UDPSINK_SENTINELUPIPE_CONTROL_LOCAL
UPIPE_UDPSINK_GET_FDunknownget socket fd (int*) *
UPIPE_UDPSINK_SET_FDunknownset socket fd (int) *
UPIPE_UDPSINK_SET_PEERunknownset remote address (const struct sockaddr *, socklen_t) *

int upipe_udpsink_get_fd(struct upipe *upipe, int *fd_p)  

This function is declared in upipe-modules/upipe_udp_sink.h source file, line 69.

This function returns currently opened udp fd.

Parameter list:

  • upipe: description structure of the pipe
  • fd_p: filled in with the fd of the udp

The return value is false in case of error

struct upipe_mgr * upipe_udpsink_mgr_alloc(void )  

This function is declared in upipe-modules/upipe_udp_sink.h source file, line 60.

This function returns the management structure for all udp sinks.

The return value is pointer to manager

int upipe_udpsink_set_fd(struct upipe *upipe, int fd)  

This function is declared in upipe-modules/upipe_udp_sink.h source file, line 81.

This function sets the udp fd.

Parameter list:

  • upipe: description structure of the pipe
  • fd: file descriptor

The return value is false in case of error

int upipe_udpsink_set_peer(struct upipe *upipe, const struct sockaddr *addr, socklen_t addrlen)  

This function is declared in upipe-modules/upipe_udp_sink.h source file, line 95.

This function sets the remote address (for unconnected sockets).

Parameter list:

  • upipe: description structure of the pipe
  • addr: the remote address
  • addrlen: the size of addr

The return value is false in case of error

Valid XHTML 1.0 StrictGenerated by cmassiot on Fri Feb 2 23:57:18 2018 using MkDoc