pjsip_module class final

The declaration for SIP module. This structure would be passed to #pjsip_endpt_register_module() to register the module to PJSIP.

Inheritance
Implemented types
Available extensions

Constructors

pjsip_module()

Properties

address → Pointer<T>

Available on T, provided by the StructAddress extension

The memory address of the underlying data.
no setter
hashCode → int
The hash code for this object.
no setterinherited
id ↔ int
Module ID. Application must initialize this field with -1 before registering the module to PJSIP. After the module is registered, this field will contain a unique ID to identify the module.
getter/setter pair
load ↔ Pointer<NativeFunction<pj_status_t Function(Pointer<pjsip_endpoint> endpt)>>
Optional function to be called to initialize the module. This function will be called by endpoint during module registration. If the value is NULL, then it's equal to returning PJ_SUCCESS.
getter/setter pair
name ↔ pj_str_t
Module name to identify the module.
getter/setter pair
next ↔ Pointer<pjsip_module>
getter/setter pair
on_rx_request ↔ Pointer<NativeFunction<pj_bool_t Function(Pointer<pjsip_rx_data> rdata)>>
Optional function to be called to process incoming request message.
getter/setter pair
on_rx_response ↔ Pointer<NativeFunction<pj_bool_t Function(Pointer<pjsip_rx_data> rdata)>>
Optional function to be called to process incoming response message.
getter/setter pair
on_tsx_state ↔ Pointer<NativeFunction<Void Function(Pointer<pjsip_transaction> tsx, Pointer<pjsip_event> event)>>
Optional function to be called when this module is acting as transaction user for the specified transaction, when the transaction's state has changed.
getter/setter pair
on_tx_request ↔ Pointer<NativeFunction<pj_status_t Function(Pointer<pjsip_tx_data> tdata)>>
Optional function to be called when transport layer is about to transmit outgoing request message.
getter/setter pair
on_tx_response ↔ Pointer<NativeFunction<pj_status_t Function(Pointer<pjsip_tx_data> tdata)>>
Optional function to be called when transport layer is about to transmit outgoing response message.
getter/setter pair
prev ↔ Pointer<pjsip_module>
getter/setter pair
priority ↔ int
Integer number to identify module initialization and start order with regard to other modules. Higher number will make the module gets initialized later.
getter/setter pair
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
start ↔ Pointer<NativeFunction<pj_status_t Function()>>
Optional function to be called to start the module. This function will be called by endpoint during module registration. If the value is NULL, then it's equal to returning PJ_SUCCESS.
getter/setter pair
stop ↔ Pointer<NativeFunction<pj_status_t Function()>>
Optional function to be called to deinitialize the module before it is unloaded. This function will be called by endpoint during module unregistration. If the value is NULL, then it's equal to returning PJ_SUCCESS.
getter/setter pair
unload ↔ Pointer<NativeFunction<pj_status_t Function()>>
Optional function to be called to deinitialize the module before it is unloaded. This function will be called by endpoint during module unregistration. If the value is NULL, then it's equal to returning PJ_SUCCESS.
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