2.2.5.1 ASYNCEVENTMSG

  • Article


0


1


2


3


4


5


6


7


8


9

1
0


1


2


3


4


5


6


7


8


9

2
0


1


2


3


4


5


6


7


8


9

3
0


1

TotalSize

InitContext

PostProcessProcContext

hDevice

Msg

OpenContext

Param1

Param2

Param3

Param4

VarData (variable)

...

TotalSize (4 bytes): An unsigned 32-bit integer. The total size, in bytes, of this packet and any trailing variable-length data.

InitContext (4 bytes): An unsigned 32-bit integer. An opaque, client-specified session value that MUST be equal to the InitContext value specified in the original scoping of the line Initialize or the phone Initialize requests.

PostProcessProcContext (4 bytes): An unsigned 32-bit integer. An opaque, client-specified value that MUST be equal to the lpContext value in the original request.

hDevice (4 bytes): An unsigned 32-bit integer. The handle of the object that pertains to the packet. For instance, hCall for the LINE_CALLSTATE packet.

This field is unused for some packets, for example, LINE_REPLY or PHONE_REPLY.

If hDevice refers to a line device handle and the hRemoteLine value specified in the original scoping of the line Open request was nonzero, then the server MUST set this field to the hRemoteLine value.

If hDevice refers to a phone device handle and the hRemotePhone value specified in the original scoping of the phone Open request was nonzero, then the server MUST set this field to the hRemotePhone value.

Msg (4 bytes): An unsigned 32-bit integer. The packet type identifier. The value MUST be one of the packet type identifier values in the completion packets in section 2.2.4.2.1.

OpenContext (4 bytes): An unsigned 32-bit integer. An opaque, client-specified value that MUST be equal to the OpenContext value specified in the original scoping of the line Open or the phone Open requests.

Param1 (4 bytes): An unsigned 32-bit integer. An event-specific value.

Param2 (4 bytes): An unsigned 32-bit integer. An event-specific value.

Param3 (4 bytes): An unsigned 32-bit integer. An event-specific value.

Param4 (4 bytes): An unsigned 32-bit integer. An event-specific value.

VarData (variable): Any variable length data. This field is an optional and dependent on packet usage

This packet serves as a template for the Response Packets.