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 *);
......
This diff is collapsed.
......@@ -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)
......
This diff is collapsed.
......@@ -25,12 +25,14 @@
#ifndef TPORT_TLS_H
/** Defined when <tport_tls.h> has been included. */
#define TPORT_TLS_H
/**@IFILE tport_tls.h
* @brief TLS interface
*
/**@internal
* @file tport_tls.h
* @brief Internal TLS interface
*
* @author Mikko Haataja <ext-Mikko.A.Haataja@nokia.com>
*
* Copyright 2001, 2002 Nokia Research Center. All rights reserved.
*
*/
#ifndef SU_TYPES_H
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment