Commit 377c8ca9 authored by Pekka Pessi's avatar Pekka Pessi

tport: updated documentation

darcs-hash:20070920173622-65a35-344f484ee50de63c28e6e9b82658784672064641.gz
parent 3a1f25bf
......@@ -270,16 +270,16 @@ TPORT_DLL int tport_has_tls(tport_t const *tport);
/** Return true if transport is being updated. */
TPORT_DLL int tport_is_updating(tport_t const *self);
/** Test if transport has been closed (added to @VERSION_1_12_4 ) */
/** Test if transport has been closed. @NEW_1_12_4. */
TPORT_DLL int tport_is_closed(tport_t const *self);
/** Test if transport has been shut down (added to @VERSION_1_12_4 ) */
/** Test if transport has been shut down. @NEW_1_12_4. */
TPORT_DLL int tport_is_shutdown(tport_t const *self);
/** Test if transport is connected. @NEW_1_12_5 */
/** Test if transport is connected. @NEW_1_12_5. */
TPORT_DLL int tport_is_connected(tport_t const *self);
/** Test if transport can be used to send message. @NEW_1_12_7 */
/** Test if transport can be used to send message. @NEW_1_12_7. */
TPORT_DLL int tport_is_clear_to_send(tport_t const *self);
/** Set transport magic. */
......@@ -381,12 +381,6 @@ tport_sigcomp_compartment(tport_t *self,
char const *name, isize_t namelen,
int create_if_needed);
TPORT_DLL struct sigcomp_compartment *
tport_compartment_incref(struct sigcomp_compartment *cc);
TPORT_DLL void
tport_compartment_decref(struct sigcomp_compartment **pointer_to_cc);
/** Assign a SigComp compartment to a connection-oriented tport. */
TPORT_DLL int
tport_sigcomp_assign(tport_t *self, struct sigcomp_compartment *);
......
......@@ -51,46 +51,24 @@ TPORT_DLL extern tagi_t tport_tags[];
TPORT_DLL extern tag_typedef_t tptag_any;
TPORT_DLL extern tag_typedef_t 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_IDENT(x) tptag_ident, tag_str_v((x))
TPORT_DLL extern tag_typedef_t tptag_ident_ref;
#define TPTAG_IDENT_REF(x) tptag_ident_ref, tag_str_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_REUSE(x) tptag_reuse, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_reuse_ref;
#define TPTAG_REUSE_REF(x) tptag_reuse_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_FRESH(x) tptag_fresh, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_fresh_ref;
#define TPTAG_FRESH_REF(x) tptag_fresh_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t tptag_server;
/** Bind server sockets (true by default, disable with TPTAG_SERVER(0)).
*
* Use with tport_tbind().
*/
#define TPTAG_SERVER(x) tptag_server, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_server_ref;
......@@ -111,197 +89,78 @@ typedef enum tport_via {
} tport_pri_type_t;
TPORT_DLL extern tag_typedef_t 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_PUBLIC(x) tptag_public, tag_int_v((x))
TPORT_DLL extern tag_typedef_t tptag_public_ref;
#define TPTAG_PUBLIC_REF(x) tptag_public_ref, tag_int_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_MTU(x) tptag_mtu, tag_usize_v((x))
TPORT_DLL extern tag_typedef_t tptag_mtu_ref;
#define TPTAG_MTU_REF(x) tptag_mtu_ref, tag_usize_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_CONNECT(x) tptag_connect, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_connect_ref;
#define TPTAG_CONNECT_REF(x) tptag_connect_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_QUEUESIZE(x) tptag_queuesize, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_queuesize_ref;
#define TPTAG_QUEUESIZE_REF(x) tptag_queuesize_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_SDWN_ERROR(x) tptag_sdwn_error, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_sdwn_error_ref;
#define TPTAG_SDWN_ERROR_REF(x) tptag_sdwn_error_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_AFTER(x) tptag_sdwn_after, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_sdwn_after_ref;
#define TPTAG_SDWN_AFTER_REF(x) tptag_sdwn_after_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_CLOSE_AFTER(x) tptag_close_after, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_close_after_ref;
#define TPTAG_CLOSE_AFTER_REF(x) tptag_close_after_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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).
*
* @par 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_IDLE(x) tptag_idle, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_idle_ref;
#define TPTAG_IDLE_REF(x) tptag_idle_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_TIMEOUT(x) tptag_timeout, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_timeout_ref;
#define TPTAG_TIMEOUT_REF(x) tptag_timeout_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t tptag_keepalive;
/**Keepalive interval in milliseconds.
*
* If 0 or UINT_MAX, do not use keepalives. Default value is 0.
*
* On TCP, the keepalive if a CR-LF-CR-LF sequence.
*
* 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().
*
* @sa TPTAG_PINGPONG(), TPTAG_PONG2PING(), TPTAG_TIMEOUT(), TPTAG_IDLE()
*
* @NEW_1_12_7
*/
#define TPTAG_KEEPALIVE(x) tptag_keepalive, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_keepalive_ref;
#define TPTAG_KEEPALIVE_REF(x) tptag_keepalive_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t tptag_pingpong;
/**Ping-pong interval in milliseconds.
*
* If 0 or UINT_MAX, do not check for PONGs. Default value is 0.
*
* If set, the ping-pong protocol is used on TCP connections. If pinger
* sends a ping and receives no data in the specified ping-pong interval, it
* considers the connection failed and closes it. The value recommended in
* draft-ietf-sip-outbound-10 is 10 seconds (10000 milliseconds).
*
* 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().
*
* @sa TPTAG_PONG2PING(), TPTAG_KEEPALIVE(), TPTAG_TIMEOUT(), TPTAG_IDLE(),
* draft-ietf-sip-outbound-10.txt
*
* @NEW_1_12_7
*/
#define TPTAG_PINGPONG(x) tptag_pingpong, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_pingpong_ref;
#define TPTAG_PINGPONG_REF(x) tptag_pingpong_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t tptag_pong2ping;
/**Respond PING with PONG.
*
* If true, respond with PONG to PING. Default value is 0 (false).
*
* If set, the ping-pong protocol is used on TCP connections. If a ping (at
* least 4 whitespace characters) is received within messages, a pong
* (CR-LF) is sent in response.
*
* 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().
*
* @sa TPTAG_PINGPONG(), TPTAG_KEEPALIVE(), TPTAG_TIMEOUT(), TPTAG_IDLE()
*
* @NEW_1_12_7
*/
#define TPTAG_PONG2PING(x) tptag_pong2ping, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_pong2ping_ref;
#define TPTAG_PONG2PING_REF(x) tptag_pong2ping_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_SIGCOMP_LIFETIME(x) tptag_sigcomp_lifetime, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_sigcomp_lifetime_ref;
......@@ -309,10 +168,6 @@ TPORT_DLL extern tag_typedef_t tptag_sigcomp_lifetime_ref;
tptag_sigcomp_lifetime_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t tptag_compartment;
/** Pointer to SigComp compartment.
*
* @note Not used.
*/
#define TPTAG_COMPARTMENT(x) tptag_compartment, tag_ptr_v((x))
TPORT_DLL extern tag_typedef_t tptag_compartment_ref;
......@@ -320,22 +175,12 @@ TPORT_DLL extern tag_typedef_t tptag_compartment_ref;
tptag_compartment_ref, tag_ptr_vr(&(x), x)
TPORT_DLL extern tag_typedef_t 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_CERTIFICATE(x) tptag_certificate, tag_str_v((x))
TPORT_DLL extern tag_typedef_t tptag_certificate_ref;
#define TPTAG_CERTIFICATE_REF(x) tptag_certificate_ref, tag_str_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_TLS_VERSION(x) tptag_tls_version, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_tls_version_ref;
......@@ -343,10 +188,6 @@ TPORT_DLL extern tag_typedef_t tptag_tls_version_ref;
#if 0
TPORT_DLL extern tag_typedef_t tptag_trusted;
/** Mark transport as trusted.
*
* @note Not implemented.
*/
#define TPTAG_TRUSTED(x) tptag_trusted, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_trusted_ref;
......@@ -354,140 +195,60 @@ TPORT_DLL extern tag_typedef_t tptag_trusted_ref;
#endif
TPORT_DLL extern tag_typedef_t 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_DEBUG_DROP(x) tptag_debug_drop, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_debug_drop_ref;
#define TPTAG_DEBUG_DROP_REF(x) tptag_debug_drop_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_RMEM(x) tptag_udp_rmem, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_udp_rmem_ref;
#define TPTAG_UDP_RMEM_REF(x) tptag_udp_rmem_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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().
*/
#define TPTAG_UDP_WMEM(x) tptag_udp_wmem, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_udp_wmem_ref;
#define TPTAG_UDP_WMEM_REF(x) tptag_udp_wmem_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_THRPSIZE(x) tptag_thrpsize, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_thrpsize_ref;
#define TPTAG_THRPSIZE_REF(x) tptag_thrpsize_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_THRPRQSIZE(x) tptag_thrprqsize, tag_uint_v((x))
TPORT_DLL extern tag_typedef_t tptag_thrprqsize_ref;
#define TPTAG_THRPRQSIZE_REF(x) tptag_thrprqsize_ref, tag_uint_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_HTTP_CONNECT(x) tptag_http_connect, tag_str_v((x))
TPORT_DLL extern tag_typedef_t tptag_http_connect_ref;
#define TPTAG_HTTP_CONNECT_REF(x) tptag_http_connect_ref, tag_str_vr(&(x))
TPORT_DLL extern tag_typedef_t 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_STUN_SERVER(x) tptag_stun_server, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_stun_server_ref;
#define TPTAG_STUN_SERVER_REF(x) tptag_stun_server_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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().
*
* @NEW_1_12_5
*/
#define TPTAG_TOS(x) tptag_tos, tag_int_v((x))
TPORT_DLL extern tag_typedef_t tptag_tos_ref;
#define TPTAG_TOS_REF(x) tptag_tos_ref, tag_int_vr(&(x))
TPORT_DLL extern tag_typedef_t 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().
*
* @sa #TPORT_LOG environment variable, TPTAG_DUMP()
*
* @NEW_1_12_5
*/
#define TPTAG_LOG(x) tptag_log, tag_bool_v((x))
TPORT_DLL extern tag_typedef_t tptag_log_ref;
#define TPTAG_LOG_REF(x) tptag_log_ref, tag_bool_vr(&(x))
TPORT_DLL extern tag_typedef_t 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().
*
* @sa #TPORT_DUMP environment variable, TPTAG_LOG().
*
* @NEW_1_12_5
*/
#define TPTAG_DUMP(x) tptag_dump, tag_str_v((x))
TPORT_DLL extern tag_typedef_t tptag_dump_ref;
......
......@@ -236,9 +236,9 @@ int tport_is_reliable(tport_t const *self)
/** Return 0 if self is local, nonzero otherwise.
*
* The return valu is the
* The return valu is the tport_via enum.
*
* @sa TPTAG_PUBLIC(), enum #tport_via.
* @sa TPTAG_PUBLIC(), enum tport_via.
*/
int tport_is_public(tport_t const *self)
{
......@@ -312,13 +312,13 @@ su_inline int tport_is_bound(tport_t const *self)
return self->tp_protoname != NULL;
}
/** Test if transport connection has been established. @NEW_1_12_5 */
/** Test if transport connection has been established. @NEW_1_12_5. */
int tport_is_connected(tport_t const *self)
{
return self->tp_is_connected;
}
/** Test if transport can be used to send message. @NEW_1_12_7 */
/** Test if transport can be used to send message. @NEW_1_12_7. */
int tport_is_clear_to_send(tport_t const *self)
{
return
......@@ -331,7 +331,7 @@ int tport_is_clear_to_send(tport_t const *self)
!self->tp_send_close);
}
/** Return true if transport has message in send queue. @NEW_1_12_7 */
/** Return true if transport has message in send queue. @NEW_1_12_7. */
int tport_has_queued(tport_t const *self)
{
return self && self->tp_queue && self->tp_queue[self->tp_qhead];
......
......@@ -4,11 +4,14 @@
The @b tport module contains a generic transport interface used by SIP,
RTSP, and HTTP protocols. It is an abstraction layer between a protocol
stack and a transport protocol implementation. The interface is
implemented via transport objects.
stack and a transport protocol implementation. The interface is implemented
via transport objects. The tag parameters for transport objects are defined
in <sofia-sip/tport_tag.h>.
@CONTACT Pekka.Pessi@nokia.com
@STATUS @SofiaSIP Core library
@LICENSE LGPL
@section tp_primary Master, Primary and Secondary Transport Objects
......@@ -102,7 +105,7 @@ was sent after lost one but did not need any retransmissions.
Transport magic is a cookie, a piece of data specified by stack that can
be associated with a transport (e.g., a Via header). The protocol stack
can change the type of transport magic by defining the macro
#TP_MAGIC_T before including <tport.h>.
#TP_MAGIC_T before including <sofia-sip/tport.h>.
@section tp_op Transport Operations
......
......@@ -26,8 +26,9 @@
/** Defined when <tport_internal.h> has been included. */
#define TPORT_INTERNAL_H
/**@file tport_internal.h
* @brief Transport interface
/**@internal
* @file tport_internal.h
* @brief Internal implementation of transport interface
*
* @author Pekka Pessi <Pekka.Pessi@nokia.com>
*
......@@ -89,7 +90,7 @@ struct sigcomp_compartment;
typedef long unsigned LU; /* for printf() and friends */
/** Transport parameters */
/** @internal Transport parameters */
typedef struct {
unsigned tpp_mtu; /**< Maximum packet size */
unsigned tpp_idle; /**< Allowed connection idle time. */
......@@ -116,7 +117,7 @@ typedef struct {
} tport_params_t;
/** Transport object.
/** @internal Transport object.
*
* A transport object can be used in three roles, to represent transport
* list (aka master transport), to represent available transports (aka
......@@ -225,7 +226,7 @@ struct tport_s {
} tp_stats;
};
/** Primary structure */
/** @internal Primary structure */
struct tport_primary {
tport_t pri_primary[1]; /**< Transport part */
#if DOXYGEN_ONLY
......@@ -257,7 +258,7 @@ struct tport_primary {
tport_params_t pri_params[1]; /**< Transport parameters */
};
/** Master structure */
/** @internal Master structure */
struct tport_master {
tport_t mr_master[1];
#if DOXYGEN_ONLY
......@@ -320,7 +321,7 @@ struct tport_master {
#endif
};
/** Virtual function table for transports */
/** @internal Virtual function table for transports */
struct tport_vtable
{
char const *vtp_name;
......@@ -364,13 +365,13 @@ struct tport_vtable
int tport_register_type(tport_vtable_t const *vtp);
/** Test if transport is needs connect() before sending. */
/** @internal Test if transport is needs connect() before sending. */
su_inline int tport_is_connection_oriented(tport_t const *self)
{
return self->tp_conn_orient;
}
/** Test if transport involves connection. @NEW_1_12_5 */
/** @internal Test if transport involves connection. @NEW_1_12_5. */
su_inline int tport_has_connection(tport_t const *self)
{
return self->tp_has_connection;
......
......@@ -52,13 +52,13 @@
typedef struct tport_sigcomp_handler tport_sigcomp_handler_t;
/** Per end-point SigComp data */
/** @internal Per end-point SigComp data */
struct tport_compressor {
struct sigcomp_state_handler *msc_state_handler;
struct sigcomp_compartment *msc_compartment;
};
/** Per-socket SigComp data */
/** @internal Per-socket SigComp data */
struct tport_comp {
struct sigcomp_udvm *sc_udvm;
struct sigcomp_compartment *sc_cc;
......
......@@ -143,6 +143,7 @@ int tport_has_compression(tport_t const *self, char const *comp)
self->tp_name->tpn_comp == tport_canonize_comp(comp);
}
/** Set the compression protocol as @a comp. */
int tport_set_compression(tport_t *self, char const *comp)
{
tport_comp_vtable_t const *vsc = tport_comp_vtable;
......@@ -153,7 +154,7 @@ int tport_set_compression(tport_t *self, char const *comp)
return (self == NULL || comp) ? -1 : 0;
}
/** Set options to SigComp */
/** Set SigComp options. */
int tport_sigcomp_option(tport_t const *self,
struct sigcomp_compartment *cc,
char const *option)
......