sofia-sip/tport_tag.h File Reference


Detailed Description

Tags for tport module.

Author:
Pekka Pessi <Pekka.Pessi@nokia-email.address.hidden>
Date:
Created: Sat Oct 12 18:39:48 2002 ppessi

#include <sofia-sip/su_tag.h>

Include dependency graph for tport_tag.h:

Go to the source code of this file.

Defines

#define TPTAG_ANY()
 Filter tag matching any tport tag.
#define TPTAG_IDENT(x)
 Identify a transport interface.
#define TPTAG_REUSE(x)
 Allow reusing transport connection (true by default).
#define TPTAG_FRESH(x)
 Create new connection (but allow other messages to reuse the new one).
#define TPTAG_SERVER(x)
 Bind server sockets (true by default, disable with TPTAG_SERVER(0)).
#define TPTAG_PUBLIC(x)
 Use a transport reaching to public Internet.
#define TPTAG_MTU(x)
 Specify MTU.
#define TPTAG_CONNECT(x)
 Specify that tport must always use connections (even with UDP).
#define TPTAG_QUEUESIZE(x)
 Specify the number of messages that can be queued per connection.
#define TPTAG_SDWN_ERROR(x)
 If true, half close of a connection by remote is considered as an error.
#define TPTAG_SDWN_AFTER(x)
 Half-close (shutdown(c, 1)) after sending the message.
#define TPTAG_CLOSE_AFTER(x)
 Close of a connection after sending the message.
#define TPTAG_IDLE(x)
 How long transports may be idle (value in milliseconds).
#define TPTAG_TIMEOUT(x)
 Timeout for incomplete incoming message (value in milliseconds).
#define TPTAG_SIGCOMP_LIFETIME(x)
 Default SigComp lifetime in seconds.
#define TPTAG_COMPARTMENT(x)
 Pointer to SigComp compartment.
#define TPTAG_CERTIFICATE(x)
 Path to the public key certificate directory.
#define TPTAG_TLS_VERSION(x)
 Sets the TLS version (version 0 implies SSL2/SSL3).
#define TPTAG_DEBUG_DROP(x)
 Sets the drop propability for (0.
#define TPTAG_UDP_RMEM(x)
 Sets the maximum receive buffer in bytes for primary UDP socket.
#define TPTAG_UDP_WMEM(x)
 Sets the maximum send buffer in bytes for primary UDP socket.
#define TPTAG_THRPSIZE(x)
 Determines the number of threads in the pool.
#define TPTAG_THRPRQSIZE(x)
 Length of per-thread receive queue (as messages).
#define TPTAG_HTTP_CONNECT(x)
 Specify that tport can use HTTP connect method.
#define TPTAG_STUN_SERVER(x)
 Enable STUN server.
#define TPTAG_TOS(x)
 Sets the IP TOS for the socket.
#define TPTAG_LOG(x)
 If set, print out parsed or sent messages at transport layer.
#define TPTAG_DUMP(x)
 Filename for dumping unparsed messages from transport.

Typedefs

typedef enum tport_via tport_pri_type_t
 Define how the public transport connects to Internet.

Enumerations

enum  tport_via
 Define how the public transport connects to Internet. More...

Variables

TPORT_DLL tagi_t tport_tag_list []
 List of all tport tags.
TPORT_DLL tagi_t tport_tags []
 Filter list matching any tport tag.


Define Documentation

#define TPTAG_CERTIFICATE (  ) 

Path to the public key certificate directory.

Use with tport_tbind(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_CLOSE_AFTER (  ) 

Close of a connection after sending the message.

Use with tport_tsend(), nta_outgoing_tcreate(), nta_outgoing_mcreate(), or nth_client_tcreate().

#define TPTAG_COMPARTMENT (  ) 

Pointer to SigComp compartment.

Note:
Not used.

#define TPTAG_CONNECT (  ) 

Specify that tport must always use connections (even with UDP).

Note:
Unimplemented (?).
Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_DEBUG_DROP (  ) 

Sets the drop propability for (0.

.1000) incoming/outgoing packets.

This is a parameter suitable for debugging only.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_DUMP (  ) 

Filename for dumping unparsed messages from transport.

Use with tport_tcreate(), nta_agent_create(), nua_create(), nth_engine_create(), or initial nth_site_create().

See also:
TPORT_DUMP, TPTAG_LOG().
Since:
New in 1.12.5

#define TPTAG_FRESH (  ) 

Create new connection (but allow other messages to reuse the new one).

Use with tport_tsend(), nta_outgoing_tcreate(), nta_outgoing_mcreate(), or nth_client_tcreate().

#define TPTAG_HTTP_CONNECT (  ) 

Specify that tport can use HTTP connect method.

Use with tport_tbind(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_IDENT (  ) 

Identify a transport interface.

Use with tport_tbind(), tport_tsend(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nta_outgoing_tcreate(), nta_outgoing_mcreate(), nth_engine_create(), nth_client_tcreate(), or initial nth_site_create().

#define TPTAG_IDLE (  ) 

How long transports may be idle (value in milliseconds).

If 0, zap immediately, if UINT_MAX, leave them there (default value for now).

Use With
tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_LOG (  ) 

If set, print out parsed or sent messages at transport layer.

Use with tport_tcreate(), nua_create(), nta_agent_create(), nth_engine_create(), or initial nth_site_create().

See also:
TPORT_DUMP, TPTAG_DUMP()
Since:
New in 1.12.5

#define TPTAG_MTU (  ) 

Specify MTU.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), tport_tsend(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nta_outgoing_tcreate(), nta_outgoing_mcreate(), nth_engine_create(), nth_client_tcreate(), or initial nth_site_create().

#define TPTAG_PUBLIC (  ) 

Use a transport reaching to public Internet.

Use with tport_tbind(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_QUEUESIZE (  ) 

Specify the number of messages that can be queued per connection.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_REUSE (  ) 

Allow reusing transport connection (true by default).

Use with tport_tcreate(), tport_tbind(), tport_set_params(), tport_tsend(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nta_outgoing_tcreate(), nta_outgoing_mcreate(), nth_engine_create(), nth_client_tcreate(), or initial nth_site_create().

#define TPTAG_SDWN_AFTER (  ) 

Half-close (shutdown(c, 1)) after sending the message.

Use with tport_tsend(), nta_outgoing_tcreate(), nta_outgoing_mcreate(), or nth_client_tcreate().

#define TPTAG_SDWN_ERROR (  ) 

If true, half close of a connection by remote is considered as an error.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_SERVER (  ) 

Bind server sockets (true by default, disable with TPTAG_SERVER(0)).

Use with tport_tbind().

#define TPTAG_SIGCOMP_LIFETIME (  ) 

Default SigComp lifetime in seconds.

If value is UINT_MAX, keep SigComp compartments around for ever.

Note:
Experimental.
Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_STUN_SERVER (  ) 

Enable STUN server.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_THRPRQSIZE (  ) 

Length of per-thread receive queue (as messages).

This is a parameter suitable for tuning.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_THRPSIZE (  ) 

Determines the number of threads in the pool.

The thread pools can have multiple threads receiving, uncompressing, parsing, compressing, and sending messages.

This is a parameter suitable for tuning.

Note:
Thread pools are currently broken.
Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_TIMEOUT (  ) 

Timeout for incomplete incoming message (value in milliseconds).

If UINT_MAX, leave the incomplete messages there for ever. Default value for now is UINT_MAX.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_TLS_VERSION (  ) 

Sets the TLS version (version 0 implies SSL2/SSL3).

Use with tport_tbind(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_TOS (  ) 

Sets the IP TOS for the socket.

Use with tport_tcreate(), tport_tbind(), tport_set_params(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

Since:
New in 1.12.5

#define TPTAG_UDP_RMEM (  ) 

Sets the maximum receive buffer in bytes for primary UDP socket.

This is a parameter suitable for tuning.

Use with tport_tbind(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().

#define TPTAG_UDP_WMEM (  ) 

Sets the maximum send buffer in bytes for primary UDP socket.

This is a parameter suitable for tuning.

Use with tport_tbind(), nua_create(), nta_agent_create(), nta_agent_add_tport(), nth_engine_create(), or initial nth_site_create().


Typedef Documentation

typedef enum tport_via tport_pri_type_t

Define how the public transport connects to Internet.

See also:
TPTAG_PUBLIC(), tport_is_public().


Enumeration Type Documentation

enum tport_via

Define how the public transport connects to Internet.

See also:
TPTAG_PUBLIC(), tport_is_public().


Sofia-SIP 1.12.6 - Copyright (C) 2006 Nokia Corporation. All rights reserved. Licensed under the terms of the GNU Lesser General Public License.