pjsip_tx_data Struct Reference
[Transport]

#include <sip_transport.h>

---

Detailed Description

Data structure for sending outgoing message. Application normally creates this buffer by calling pjsip_endpt_create_tdata.

The lifetime of this buffer is controlled by the reference counter in this structure, which is manipulated by calling pjsip_tx_data_add_ref and pjsip_tx_data_dec_ref. When the reference counter has reached zero, then this buffer will be destroyed.

A transaction object normally will add reference counter to this buffer when application calls pjsip_tsx_send_msg, because it needs to keep the message for retransmission. The transaction will release the reference counter once its state has reached final state.

Public Member Functions
	PJ_DECL_LIST_MEMBER (struct pjsip_tx_data)
Data Fields
pj_pool_t *	pool
char	obj_name [PJ_MAX_OBJ_NAME]
char *	info
pj_time_val	rx_timestamp
pjsip_tpmgr *	mgr
pjsip_tx_data_op_key	op_key
pj_lock_t *	lock
pjsip_msg *	msg
pjsip_route_hdr *	saved_strict_route
pjsip_buffer	buf
pj_atomic_t *	ref_cnt
int	is_pending
void *	token
void(*	cb )(void *, pjsip_tx_data *, pj_ssize_t)
struct {
pjsip_transport *   transport
pj_sockaddr   dst_addr
int   dst_addr_len
char   dst_name [PJ_INET6_ADDRSTRLEN]
int   dst_port
}	tp_info
pjsip_tpselector	tp_sel

---

Member Function Documentation

pjsip_tx_data::PJ_DECL_LIST_MEMBER

(

struct

pjsip_tx_data

)

This is for transmission queue; it's managed by transports.

---

Field Documentation

pj_pool_t* pjsip_tx_data::pool

Memory pool for this buffer.

char pjsip_tx_data::obj_name[PJ_MAX_OBJ_NAME]

A name to identify this buffer.

char* pjsip_tx_data::info

Short information describing this buffer and the message in it. Application should use pjsip_tx_data_get_info() instead of directly accessing this member.

pj_time_val pjsip_tx_data::rx_timestamp

For response message, this contains the reference to timestamp when the original request message was received. The value of this field is set when application creates response message to a request by calling pjsip_endpt_create_response.

pjsip_tpmgr* pjsip_tx_data::mgr

The transport manager for this buffer.

pjsip_tx_data_op_key pjsip_tx_data::op_key

Ioqueue asynchronous operation key.

pj_lock_t* pjsip_tx_data::lock

Lock object.

pjsip_msg* pjsip_tx_data::msg

The message in this buffer.

pjsip_route_hdr* pjsip_tx_data::saved_strict_route

Strict route header saved by pjsip_process_route_set(), to be restored by pjsip_restore_strict_route_set().

pjsip_buffer pjsip_tx_data::buf

Buffer to the printed text representation of the message. When the content of this buffer is set, then the transport will send the content of this buffer instead of re-printing the message structure. If the message structure has changed, then application must invalidate this buffer by calling pjsip_tx_data_invalidate_msg.

pj_atomic_t* pjsip_tx_data::ref_cnt

Reference counter.

int pjsip_tx_data::is_pending

Being processed by transport?

void* pjsip_tx_data::token

Transport manager internal.

void(* pjsip_tx_data::cb)(void *, pjsip_tx_data *, pj_ssize_t)

Callback to be called when this tx_data has been transmitted.

pjsip_transport* pjsip_tx_data::transport

Transport being used.

pj_sockaddr pjsip_tx_data::dst_addr

Destination address.

int pjsip_tx_data::dst_addr_len

Length of address.

char pjsip_tx_data::dst_name[PJ_INET6_ADDRSTRLEN]

Destination address.

int pjsip_tx_data::dst_port

Destination port.

struct { ... } pjsip_tx_data::tp_info

Transport information, only valid during on_tx_request() and on_tx_response() callback.

pjsip_tpselector pjsip_tx_data::tp_sel

Transport selector, to specify which transport to be used. The value here must be set with pjsip_tx_data_set_transport(), to allow reference counter to be set properly.

---

The documentation for this struct was generated from the following file:

• sip_transport.h