Home --> Documentations --> PJNATH Reference

Various compile time settings. More...

Macros

#define PJNATH_ERROR_LEVEL   1
 
#define PJ_STUN_MAX_ATTR   16
 
#define PJ_STUN_RTO_VALUE   100
 
#define PJ_STUN_TIMEOUT_VALUE   (16 * PJ_STUN_RTO_VALUE)
 
#define PJ_STUN_MAX_TRANSMIT_COUNT   7
 
#define PJ_STUN_RES_CACHE_DURATION   10000
 
#define PJ_STUN_MAX_PKT_LEN   800
 
#define PJ_STUN_PORT   3478
 
#define PJ_STUN_STRING_ATTR_PAD_CHR   0
 
#define PJ_STUN_OLD_STYLE_MI_FINGERPRINT   0
 
#define PJ_STUN_SOCK_PKT_LEN   2000
 
#define PJ_STUN_KEEP_ALIVE_SEC   15
 
#define PJ_TURN_MAX_DNS_SRV_CNT   4
 
#define PJ_TURN_MAX_PKT_LEN   3000
 
#define PJ_TURN_PERM_TIMEOUT   300
 
#define PJ_TURN_CHANNEL_TIMEOUT   600
 
#define PJ_TURN_REFRESH_SEC_BEFORE   60
 
#define PJ_TURN_KEEP_ALIVE_SEC   15
 
#define PJ_ICE_MAX_CAND   16
 
#define PJ_ICE_ST_MAX_CAND   8
 
#define PJ_ICE_MAX_STUN   2
 
#define PJ_ICE_MAX_TURN   3
 
#define PJ_ICE_COMP_BITS   1
 
#define PJ_ICE_MAX_COMP   (2<<PJ_ICE_COMP_BITS)
 
#define PJNATH_ICE_PRIO_STD   1
 
#define PJ_ICE_CAND_TYPE_PREF_BITS   8
 
#define PJ_ICE_LOCAL_PREF_BITS   0
 
#define PJ_ICE_MAX_CHECKS   32
 
#define PJ_ICE_TA_VAL   20
 
#define PJ_ICE_CANCEL_ALL   1
 
#define ICE_CONTROLLED_AGENT_WAIT_NOMINATION_TIMEOUT   10000
 
#define PJ_ICE_NOMINATED_CHECK_DELAY   (4*PJ_STUN_RTO_VALUE)
 
#define PJ_ICE_SESS_KEEP_ALIVE_MIN   20
 
#define PJ_ICE_SESS_KEEP_ALIVE_MAX_RAND   5
 
#define PJ_ICE_UFRAG_LEN   8
 
#define PJNATH_POOL_LEN_ICE_SESS   512
 
#define PJNATH_POOL_INC_ICE_SESS   512
 
#define PJNATH_POOL_LEN_ICE_STRANS   1000
 
#define PJNATH_POOL_INC_ICE_STRANS   512
 
#define PJNATH_POOL_LEN_NATCK   512
 
#define PJNATH_POOL_INC_NATCK   512
 
#define PJNATH_POOL_LEN_STUN_SESS   1000
 
#define PJNATH_POOL_INC_STUN_SESS   1000
 
#define PJNATH_POOL_LEN_STUN_TDATA   1000
 
#define PJNATH_POOL_INC_STUN_TDATA   1000
 
#define PJNATH_POOL_LEN_TURN_SESS   1000
 
#define PJNATH_POOL_INC_TURN_SESS   1000
 
#define PJNATH_POOL_LEN_TURN_SOCK   1000
 
#define PJNATH_POOL_INC_TURN_SOCK   1000
 
#define PJNATH_MAKE_SW_NAME(a, b, c, d)   "pjnath-" #a "." #b "." #c d
 
#define PJNATH_MAKE_SW_NAME2(a, b, c, d)   PJNATH_MAKE_SW_NAME(a,b,c,d)
 
#define PJNATH_STUN_SOFTWARE_NAME
 

Detailed Description

Macro Definition Documentation

#define ICE_CONTROLLED_AGENT_WAIT_NOMINATION_TIMEOUT   10000

For a controlled agent, specify how long it wants to wait (in milliseconds) for the controlling agent to complete sending connectivity check with nominated flag set to true for all components after the controlled agent has found that all connectivity checks in its checklist have been completed and there is at least one successful (but not nominated) check for every component.

When selecting the value, bear in mind that the connectivity check from controlling agent may be delayed because of delay in receiving SDP answer from the controlled agent.

Application may set this value to -1 to disable this timer.

Default: 10000 (milliseconds)

#define PJ_ICE_CANCEL_ALL   1

According to ICE Section 8.2. Updating States, if an In-Progress pair in the check list is for the same component as a nominated pair, the agent SHOULD cease retransmissions for its check if its pair priority is lower than the lowest priority nominated pair for that component.

If a higher priority check is In Progress, this rule would cause that check to be performed even when it most likely will fail.

The macro here controls if ICE session should cancel all In Progress checks for the same component regardless of its priority.

Default: 1 (yes, cancel all)

#define PJ_ICE_CAND_TYPE_PREF_BITS   8

The number of bits to represent candidate type preference.

#define PJ_ICE_COMP_BITS   1

The number of bits to represent component IDs. This will affect the maximum number of components (PJ_ICE_MAX_COMP) value.

#define PJ_ICE_LOCAL_PREF_BITS   0

The number of bits to represent ICE candidate's local preference. The local preference is used to specify preference among candidates with the same type, and ICE draft suggests 65535 as the default local preference, which means we need 16 bits to represent the value. But since we don't have the facility to specify local preference, we'll just disable this feature and let the preference sorted by the type only.

Default: 0

#define PJ_ICE_MAX_CAND   16

Maximum number of ICE candidates.

Default: 16

#define PJ_ICE_MAX_CHECKS   32

Maximum number of ICE checks.

Default: 32

#define PJ_ICE_MAX_COMP   (2<<PJ_ICE_COMP_BITS)

Maximum number of ICE components.

#define PJ_ICE_MAX_STUN   2

Maximum number of STUN transports for each ICE stream transport component. Valid values are 1 - 64.

Default: 2

#define PJ_ICE_MAX_TURN   3

Maximum number of TURN transports for each ICE stream transport component. Valid values are 1 - 64.

Default: 2

#define PJ_ICE_NOMINATED_CHECK_DELAY   (4*PJ_STUN_RTO_VALUE)

For controlling agent if it uses regular nomination, specify the delay to perform nominated check (connectivity check with USE-CANDIDATE attribute) after all components have a valid pair.

Default: 4*PJ_STUN_RTO_VALUE (milliseconds)

#define PJ_ICE_SESS_KEEP_ALIVE_MAX_RAND   5

To prevent STUN keep-alives to be sent simultaneously, application should add random interval to minimum interval (PJ_ICE_SESS_KEEP_ALIVE_MIN). This setting specifies the maximum random value to be added to the minimum interval, in seconds.

Default: 5 seconds

See also
PJ_ICE_SESS_KEEP_ALIVE_MIN
#define PJ_ICE_SESS_KEEP_ALIVE_MIN   20

Minimum interval value to be used for sending STUN keep-alive on the ICE session, in seconds. This minimum interval, plus a random value which maximum is PJ_ICE_SESS_KEEP_ALIVE_MAX_RAND, specify the actual interval of the STUN keep-alive.

Default: 15 seconds

See also
PJ_ICE_SESS_KEEP_ALIVE_MAX_RAND
#define PJ_ICE_ST_MAX_CAND   8

Maximum number of candidates for each ICE stream transport component.

Default: 8

#define PJ_ICE_TA_VAL   20

Default timer interval (in miliseconds) for starting ICE periodic checks.

Default: 20

#define PJ_ICE_UFRAG_LEN   8

This constant specifies the length of random string generated for ICE ufrag and password.

Default: 8 (characters)

#define PJ_STUN_KEEP_ALIVE_SEC   15

The duration of the STUN keep-alive period, in seconds.

#define PJ_STUN_MAX_ATTR   16

Maximum number of attributes in the STUN packet (for the new STUN library).

Default: 16

#define PJ_STUN_MAX_PKT_LEN   800

Maximum size of STUN message.

#define PJ_STUN_MAX_TRANSMIT_COUNT   7

Maximum number of STUN transmission count.

Default: 7 (as per RFC 3489-bis)

#define PJ_STUN_OLD_STYLE_MI_FINGERPRINT   0

Enable pre-RFC3489bis-07 style of STUN MESSAGE-INTEGRITY and FINGERPRINT calculation. By default this should be disabled since the calculation is not backward compatible with current STUN specification.

#define PJ_STUN_PORT   3478

Default STUN port as defined by RFC 3489.

#define PJ_STUN_RES_CACHE_DURATION   10000

Duration to keep response in the cache, in msec.

Default: 10000 (as per RFC 3489-bis)

Referenced by pj_stun_config_init().

#define PJ_STUN_RTO_VALUE   100

The default initial STUN round-trip time estimation (the RTO value in RFC 3489-bis), in miliseconds. This value is used to control the STUN request retransmit time. The initial value of retransmission interval would be set to this value, and will be doubled after each retransmission.

Referenced by pj_stun_config_init().

#define PJ_STUN_SOCK_PKT_LEN   2000

The packet buffer size for the STUN transport.

#define PJ_STUN_STRING_ATTR_PAD_CHR   0

Padding character for string attributes.

Default: ASCII 0

#define PJ_STUN_TIMEOUT_VALUE   (16 * PJ_STUN_RTO_VALUE)

The STUN transaction timeout value, in miliseconds. After the last retransmission is sent and if no response is received after this time, the STUN transaction will be considered to have failed.

The default value is 16x RTO (as per RFC 3489-bis).

#define PJ_TURN_CHANNEL_TIMEOUT   600

The TURN channel binding lifetime. This value should be taken from the TURN protocol specification.

#define PJ_TURN_KEEP_ALIVE_SEC   15

The TURN session timer heart beat interval. When this timer occurs, the TURN session will scan all the permissions/channel bindings to see which need to be refreshed.

#define PJ_TURN_MAX_DNS_SRV_CNT   4

Maximum DNS SRV entries to be processed in the DNS SRV response

#define PJ_TURN_MAX_PKT_LEN   3000

Maximum TURN packet size to be supported.

#define PJ_TURN_PERM_TIMEOUT   300

The TURN permission lifetime setting. This value should be taken from the TURN protocol specification.

#define PJ_TURN_REFRESH_SEC_BEFORE   60

Number of seconds to refresh the permission/channel binding before the permission/channel binding expires. This value should be greater than PJ_TURN_PERM_TIMEOUT setting.

#define PJNATH_ERROR_LEVEL   1

The log level for PJNATH error display.

default 1

#define PJNATH_ICE_PRIO_STD   1

Use the priority value according to the ice-draft.

#define PJNATH_MAKE_SW_NAME (   a,
  b,
  c,
 
)    "pjnath-" #a "." #b "." #c d

Default STUN software name

#define PJNATH_POOL_INC_ICE_SESS   512

ICE session pool increment size

#define PJNATH_POOL_INC_ICE_STRANS   512

ICE stream transport pool increment size

#define PJNATH_POOL_INC_NATCK   512

NAT detect pool increment size

#define PJNATH_POOL_INC_STUN_SESS   1000

STUN session pool increment size

#define PJNATH_POOL_INC_STUN_TDATA   1000

STUN session transmit data pool increment size

#define PJNATH_POOL_INC_TURN_SESS   1000

TURN session pool increment size

#define PJNATH_POOL_INC_TURN_SOCK   1000

TURN socket pool increment size

#define PJNATH_POOL_LEN_ICE_SESS   512

ICE session pool initial size.

#define PJNATH_POOL_LEN_ICE_STRANS   1000

ICE stream transport pool initial size.

#define PJNATH_POOL_LEN_NATCK   512

NAT detect pool initial size

#define PJNATH_POOL_LEN_STUN_SESS   1000

STUN session pool initial size

#define PJNATH_POOL_LEN_STUN_TDATA   1000

STUN session transmit data pool initial size

#define PJNATH_POOL_LEN_TURN_SESS   1000

TURN session initial pool size

#define PJNATH_POOL_LEN_TURN_SOCK   1000

TURN socket initial pool size

#define PJNATH_STUN_SOFTWARE_NAME
Value:
PJNATH_MAKE_SW_NAME2( \
PJ_VERSION_NUM_MAJOR, \
PJ_VERSION_NUM_MINOR, \
PJ_VERSION_NUM_REV, \
PJ_VERSION_NUM_EXTRA)

 


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