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

ACK received for 200ok to INVITE

call_answered = 7

announce start of call

call_cancelled = 13

announce that call has been cancelled

call_closed = 21

a BYE was received for this call

call_globalfailure = 11

announce a global failure

call_invite = 2

announce a create call

call_message_answered = 16

announce a 200ok

call_message_globalfailure = 20

announce a failure.

call_message_new = 14

announce create incoming request.

call_message_proceeding = 15

announce a 1xx for request.

call_message_redirected = 17

announce a redirection.

call_message_requestfailure = 18

announce a failure.

call_message_serverfailure = 19

announce a failure.

call_noanswer = 4

announce no answer within the timeout

call_proceeding = 5

announce processing by a remote app

call_redirected = 8

announce a redirection

call_reinvite = 3

announce a create INVITE within call

call_released = 22

call context is cleared.

call_requestfailure = 9

announce a request failure

call_ringing = 6

announce ringback

call_serverfailure = 10

announce a server failure

in_subscription_new = 38

announce create incoming SUBSCRIBE.

message_answered = 25

announce a 200ok

message_globalfailure = 29

announce a failure.

message_new = 23

announce create incoming request.

message_proceeding = 24

announce a 1xx for request.

message_redirected = 26

announce a redirection.

message_requestfailure = 27

announce a failure.

message_serverfailure = 28

announce a failure.

notification_answered = 41

announce a 200ok

notification_globalfailure = 45

announce a global failure

notification_noanswer = 39

announce no answer

notification_proceeding = 40

announce a 1xx

notification_redirected = 42

announce a redirection

notification_requestfailure = 43

announce a request failure

notification_serverfailure = 44

announce a server failure

registration_failure = 1

user is not registred.

registration_success = 0

user is successfully registred.

subscription_answered = 32

announce a 200ok

subscription_globalfailure = 36

announce a global failure

subscription_noanswer = 30

announce no answer

subscription_notify = 37

announce create NOTIFY request

subscription_proceeding = 31

announce a 1xx

subscription_redirected = 33

announce a redirection

subscription_requestfailure = 34

announce a request failure

subscription_serverfailure = 35

announce a server failure