BLOG | DOCUMENTATION | TRAC

Home --> Documentations --> PJNATH Reference

pj_stun_sock_cfg Struct Reference
[STUN-aware socket transport]

Data Fields

unsigned max_pkt_size
unsigned async_cnt
pj_sockaddr bound_addr
int ka_interval
pj_qos_type qos_type
pj_qos_params qos_params
pj_bool_t qos_ignore_error

Detailed Description

This describe the settings to be given to the STUN transport during its creation. Application should initialize this structure by calling pj_stun_sock_cfg_default().


Field Documentation

Specify the number of simultaneous asynchronous read operations to be invoked to the ioqueue. Having more than one read operations will increase performance on multiprocessor systems since the application will be able to process more than one incoming packets simultaneously. Default value is 1.

Specify the interface where the socket should be bound to. If the address is zero, socket will be bound to INADDR_ANY. If the address is non-zero, socket will be bound to this address only, and the transport will have only one address alias (the alias_cnt field in pj_stun_sock_info structure.

Specify the STUN keep-alive duration, in seconds. The STUN transport does keep-alive by sending STUN Binding request to the STUN server. If this value is zero, the PJ_STUN_KEEP_ALIVE_SEC value will be used. If the value is negative, it will disable STUN keep-alive.

Packet buffer size. Default value is PJ_STUN_SOCK_PKT_LEN.

Specify if STUN socket should ignore any errors when setting the QoS traffic type/parameters.

Default: PJ_TRUE

Set the low level QoS parameters to the transport. This is a lower level operation than setting the qos_type field and may not be supported on all platforms.

By default all settings in this structure are disabled.

QoS traffic type to be set on this transport. When application wants to apply QoS tagging to the transport, it's preferable to set this field rather than qos_param fields since this is more portable.

Default value is PJ_QOS_TYPE_BEST_EFFORT.


The documentation for this struct was generated from the following file:

 


PJNATH - Open Source NAT traversal helper library supporting STUN, TURN, and ICE
Copyright (C) 2006-2009 Teluu Inc.