Dialogic Dialogic Global Call IP IP Phone User Manual


 
556 Dialogic
®
Global Call API Library Reference — November 2007
Dialogic Corporation
IP_VIRTBOARD — information about an IPT board device
ENUM_TCP – use TCP protocol for the outbound proxy; if this value is set when TCP is
not enabled or when TCP is enabled but no SIP proxy is configured, gc_Start( ) returns an
IPERR_BAD_PARM error
ENUM_TLS – use TLS for the outbound proxy; if this value is set when either TCP or
TLS is not enabled (TLS operates on top of TCP), gc_Start( ) returns an
IPERR_BAD_PARM error
ENUM_UDP (default) – use UDP protocol for the outbound proxy
E_SIP_Persistence (structure version 0x106 only)
Sets the persistence of TCP connections (assuming that TCP has been enabled via
E_SIP_tcpenabled). This field has no effect on whether TCP is used for requests; it only
affects the connections that are made when TCP is actually used. The following symbolic
values are defined:
ENUM_PERSISTENCE_NONE – no persistence; TCP connection is closed after each
request
ENUM_PERSISTENCE_TRANSACT – transaction persistence; TCP connection is
closed after each transaction
ENUM_PERSISTENCE_TRANSACT_USER (default) – user persistence; TCP
connection is maintained for the lifetime of the “user” of the transaction (the CallLeg, for
example)
SIP_maxUDPmsgLen (structure version 0x106 only)
Sets the maximum size for UDP SIP requests; above this threshold, the TCP transport protocol
is automatically used instead of UDP (assuming that TCP is enabled via E_SIP_tcpenabled).
The default value is 1300 (as recommended by RFC3261). Value may be set to 0 or
VIRTBOARD_SIP_NOUDPMSGSIZECHECK to disable the size checking and reduce the
message processing overhead.
E_SIP_DefaultTransport (structure version 0x106 only)
Sets the default transport protocol that is used when there is no proxy set (assuming that TCP
is enabled by E_SIP_tcpenabled). The application can override the default for a particular
request by explicitly specifying the transport protocol with a “transport= ” header parameter.
The following symbolic values are defined:
ENUM_TCP – use TCP unless “;transport=udp” is set by application; if this value is set
when TCP is not enabled, gc_Start( ) returns an IPERR_BAD_PARM error
ENUM_UDP (default) – use UDP unless “;transport=tcp” is set by application
E_SIP_RequestRetry (structure version 0x107 only)
Sets the behavior that the SIP stack follows when a particular address-transport combination
has failed for a SIP request; this may be a UDP failure after multiple retries or a TCP failure.
The following symbolic values are defined:
ENUM_REQUEST_RETRY_ALL (default) – there will be a retry if the DNS server has
provided a list of IP addresses with transports, and there will also be a retry on the last (or
only) address if the transport was TCP and the failure reason qualifies for retry
ENUM_REQUEST_RETRY_DNS – there will be a retry if the DNS server has provided
a list of IP addresses with transports
ENUM_REQUEST_RETRY_FORCEDTCP – there will be a retry if the DNS server has
provided a list of IP addresses with transports, and there will also be a retry on the last (or
only) address if the transport was forced to be TCP because of message length and the
failure reason qualifies for retry
ENUM_REQUEST_RETRY_NONE – there will be no retry on request failure