exosip2ctypes.event module

eXosip2 event API

see: http://www.antisip.com/doc/exosip2/group__eXosip2__event.html

class exosip2ctypes.event.Event(ptr, context)

Bases: object

Class for event description

Parameters:
ack
Returns:ack within current transaction
Return type:OsipMessage
cid
Returns:unique id for SIP calls (but multiple dialogs!)
Return type:int
did
Returns:unique id for SIP dialogs
Return type:int
dispose()

Free resource in an eXosip event.

Danger

After called this method, struct eXosip_event_t of the object is freed, following attributes will be None:

It is invoked in class destructor. Don’t call it yourself, let Python runtime’s GC dispose the structure.

disposed

Is resource in an eXosip event disposed

Return type:bool
nid
Returns:unique id for incoming subscriptions
Return type:int
request
Returns:request within current transaction
Return type:ExosipMessage
response
Returns:last response within current transaction
Return type:ExosipMessage
rid
Returns:unique id for registration
Return type:int
sid

unique id for outgoing subscriptions

Return type:int
ss_reason
Returns:current Reason status for subscription
Return type:int
ss_status
Returns:current Subscription-State for subscription
Return type:int
textinfo
Returns:text description of event
Return type:str
tid
Returns:unique id for transactions (to be used for answers)
Return type:int
type

type of the event

Return type:EventType
class exosip2ctypes.event.EventType

Bases: enum.IntEnum

Enumeration of event types

call_ack = 12
call_answered = 7
call_cancelled = 13
call_closed = 21
call_globalfailure = 11
call_invite = 2
call_message_answered = 16
call_message_globalfailure = 20
call_message_new = 14
call_message_proceeding = 15
call_message_redirected = 17
call_message_requestfailure = 18
call_message_serverfailure = 19
call_noanswer = 4
call_proceeding = 5
call_redirected = 8
call_reinvite = 3
call_released = 22
call_requestfailure = 9
call_ringing = 6
call_serverfailure = 10
in_subscription_new = 38
message_answered = 25
message_globalfailure = 29
message_new = 23
message_proceeding = 24
message_redirected = 26
message_requestfailure = 27
message_serverfailure = 28
notification_answered = 41
notification_globalfailure = 45
notification_noanswer = 39
notification_proceeding = 40
notification_redirected = 42
notification_requestfailure = 43
notification_serverfailure = 44
registration_failure = 1
registration_success = 0
subscription_answered = 32
subscription_globalfailure = 36
subscription_noanswer = 30
subscription_notify = 37
subscription_proceeding = 31
subscription_redirected = 33
subscription_requestfailure = 34
subscription_serverfailure = 35