pjsip_tx_data class final

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.

Inheritance
Implemented types
Available extensions

Constructors

pjsip_tx_data.new()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
auth_retry ↔ int
Special flag to indicate that this transmit data is a request that has been updated with proper authentication response and is ready to be sent for retry.
getter/setter pair
buf ↔ pjsip_buffer
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.
getter/setter pair
cb ↔ Pointer<NativeFunction<Void Function(Pointer<Void>, Pointer<pjsip_tx_data>, pj_ssize_t)>>
Callback to be called when this tx_data has been transmitted.
getter/setter pair
dest_info ↔ UnnamedStruct2
getter/setter pair
hashCode → int
The hash code for this object.
no setterinherited
info ↔ Pointer<Char>
Short information describing this buffer and the message in it. Application should use #pjsip_tx_data_get_info() instead of directly accessing this member.
getter/setter pair
is_pending ↔ int
Being processed by transport?
getter/setter pair
lock ↔ Pointer<pj_lock_t>
Lock object.
getter/setter pair
mgr ↔ Pointer<pjsip_tpmgr>
The transport manager for this buffer.
getter/setter pair
mod_data ↔ Array<Pointer<Void>>
Arbitrary data attached by PJSIP modules.
getter/setter pair
msg ↔ Pointer<pjsip_msg>
The message in this buffer.
getter/setter pair
next ↔ Pointer<pjsip_tx_data>
getter/setter pair
obj_name ↔ Array<Char>
A name to identify this buffer.
getter/setter pair
op_key ↔ pjsip_tx_data_op_key
Ioqueue asynchronous operation key.
getter/setter pair
pool ↔ Pointer<pj_pool_t>
Memory pool for this buffer.
getter/setter pair
prev ↔ Pointer<pjsip_tx_data>
getter/setter pair
ref_cnt ↔ Pointer<pj_atomic_t>
Reference counter.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
rx_timestamp ↔ pj_time_val
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.
getter/setter pair
saved_strict_route ↔ Pointer<pjsip_route_hdr>
Strict route header saved by #pjsip_process_route_set(), to be restored by #pjsip_restore_strict_route_set().
getter/setter pair
token ↔ Pointer<Void>
Transport manager internal.
getter/setter pair
tp_info ↔ UnnamedStruct3
getter/setter pair
tp_sel ↔ pjsip_tpselector
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.
getter/setter pair
via_addr ↔ pjsip_host_port
< Via address.
getter/setter pair
via_tp ↔ Pointer<Void>
< Via transport.
getter/setter pair

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited