aniani/icecast-common
1
0
Fork 0
mirror of https://gitlab.xiph.org/xiph/icecast-common.git synced 2024-12-04 14:46:31 -05:00
Code

Update: Added some docs

Browse Source
This commit is contained in:
Philipp Schafft 2019-10-02 06:27:16 +00:00
parent c6b2415ca2
commit 973fb3eaa4
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
include/igloo/socketaddr.h
View File

@ -40,30 +40,55 @@ extern "C" {
igloo_RO_FORWARD_TYPE(igloo_socketaddr_t); igloo_RO_FORWARD_TYPE(igloo_socketaddr_t);
/* Domain of sockets */
typedef enum { typedef enum {
/* Special value used for unspecified or not jet known domain. */
igloo_SOCKETADDR_DOMAIN_UNSPEC = 0, igloo_SOCKETADDR_DOMAIN_UNSPEC = 0,
/* Unix Domain Sockets, AKA AF_UNIX */
igloo_SOCKETADDR_DOMAIN_UNIX, igloo_SOCKETADDR_DOMAIN_UNIX,
/* IPv4 Sockets, AKA AF_INET */
igloo_SOCKETADDR_DOMAIN_INET4, igloo_SOCKETADDR_DOMAIN_INET4,
/* IPv6 Sockets, AKA AF_INET6 */
igloo_SOCKETADDR_DOMAIN_INET6 igloo_SOCKETADDR_DOMAIN_INET6
} igloo_socketaddr_domain_t; } igloo_socketaddr_domain_t;
/* Socket type */
typedef enum { typedef enum {
/* Special value used for unspecified or not jet known type. */
igloo_SOCKETADDR_TYPE_UNSPEC = 0, igloo_SOCKETADDR_TYPE_UNSPEC = 0,
/* Stream sockets */
igloo_SOCKETADDR_TYPE_STREAM, igloo_SOCKETADDR_TYPE_STREAM,
/* Datagram sockets */
igloo_SOCKETADDR_TYPE_DGRAM, igloo_SOCKETADDR_TYPE_DGRAM,
/* Sequenced and reliable datagram sockets */
igloo_SOCKETADDR_TYPE_SEQPACK, igloo_SOCKETADDR_TYPE_SEQPACK,
/* Reliable datagram sockets */
igloo_SOCKETADDR_TYPE_RDM igloo_SOCKETADDR_TYPE_RDM
} igloo_socketaddr_type_t; } igloo_socketaddr_type_t;
/* Specific socket protocol */
typedef enum { typedef enum {
/* Special value used for unspecified or not jet known protocol. */
igloo_SOCKETADDR_PROTOCOL_UNSPEC = 0, igloo_SOCKETADDR_PROTOCOL_UNSPEC = 0,
/* Transmission Control Protocol */
igloo_SOCKETADDR_PROTOCOL_TCP, igloo_SOCKETADDR_PROTOCOL_TCP,
/* User Datagram Protocol */
igloo_SOCKETADDR_PROTOCOL_UDP, igloo_SOCKETADDR_PROTOCOL_UDP,
/* Datagram Congestion Control Protocol */
igloo_SOCKETADDR_PROTOCOL_DCCP, igloo_SOCKETADDR_PROTOCOL_DCCP,
/* Stream Control Transmission Protocol */
igloo_SOCKETADDR_PROTOCOL_SCTP, igloo_SOCKETADDR_PROTOCOL_SCTP,
/* Lightweight User Datagram Protocol */
igloo_SOCKETADDR_PROTOCOL_UDPLITE igloo_SOCKETADDR_PROTOCOL_UDPLITE
} igloo_socketaddr_protocol_t; } igloo_socketaddr_protocol_t;
/* This creates a new address object.
* Parameters:
* name, associated, instance
* See igloo_ro_new().
* domain, type, protocol
* Domain, Type, and Protocol for the new address. Can be igloo_SOCKETADDR_*_UNSPEC.
*/
igloo_socketaddr_t * igloo_socketaddr_new(igloo_socketaddr_domain_t domain, igloo_socketaddr_type_t type, igloo_socketaddr_protocol_t protocol, const char *name, igloo_ro_t associated, igloo_ro_t instance, igloo_error_t *error); igloo_socketaddr_t * igloo_socketaddr_new(igloo_socketaddr_domain_t domain, igloo_socketaddr_type_t type, igloo_socketaddr_protocol_t protocol, const char *name, igloo_ro_t associated, igloo_ro_t instance, igloo_error_t *error);
igloo_error_t igloo_socketaddr_get_base(igloo_socketaddr_t *addr, igloo_socketaddr_domain_t *domain, igloo_socketaddr_type_t *type, igloo_socketaddr_protocol_t *protocol); igloo_error_t igloo_socketaddr_get_base(igloo_socketaddr_t *addr, igloo_socketaddr_domain_t *domain, igloo_socketaddr_type_t *type, igloo_socketaddr_protocol_t *protocol);