You are here: CSP API Reference > 1 EXS & SwitchKit API Messages > Resource Disconnect 0x0128
SwitchKit Name
ResourceDisconnect
Type
EXS and SwitchKit API message
Description
Use this message to disconnect a processing resource, which was previously connected using the Resource Connect message.
FAX
Use this message to disconnect a fax channel in order to interrupt fax processing on that channel.
Conferencing
Use this message to move a channel from a Child Conference back into the Parent Conference. Use the Channel AIB and the Child Conference AIB. The Channel AIB indicates the Channel to be moved from the child conference to the parent conference. The Child Conference ID AIB both the parent and child conference IDs.
Sent by
Host application
Related API Messages
Resource Create (0x0124)
Resource Modify (0x0125)
Resource Delete (0x0126)
Resource Connect (0x0127)
Resource Query (0x012C)
SwitchKit Code
C Structure
typedef struct {
UBYTE AddrInfo[30];
UBYTE DataType;
UBYTE TLVCount;
UBYTE Data[221];
} XL_ResourceDisconnect;
};
C Structure Response
typedef struct {
unsigned short Status;
UBYTE reserved6[13];
UBYTE AddrInfo[30];
UBYTE DataType;
UBYTE TLVCount;
UBYTE Data[219];
} XL_ResourceDisconnectAck;
};
C++ Class
class XLC_ResourceDisconnect : public XLC_OutboundMessage {
public:
const UBYTE *getAddrInfo() const ;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
XBYTE getParentConferenceID() const;
void setParentConferenceID(XBYTE x);
XBYTE getChildConferenceID() const;
void setChildConferenceID(XBYTE x);
XBYTE getSpan() const ;
void setSpan(XBYTE x) ;
UBYTE getChannel() const ;
void setChannel(UBYTE x) ;
UBYTE getDataType() const ;
void setDataType(UBYTE x);
UBYTE getTLVCount() const ;
void setTLVCount(UBYTE x);
const UBYTE *getData() const;
UBYTE *getData() ;
void setData(UBYTE *x)};
};
C++ Class Response
class XLC_ResourceDisconnectAck : public XLC_AcknowledgeMessage {
public:
unsigned short getStatus() const;
void setStatus(unsigned short x);
const UBYTE getAddrInfo() const;
UBYTE *getAddrInfo();
void setAddrInfo(UBYTE *x);
XBYTE getParentConferenceID() const;
void setParentConferenceID(XBYTE x);
XBYTE getChildConferenceID() const;
void setChildConferenceID(XBYTE x);
XBYTE getSpan() const;
void setSpan(XBYTE x);
UBYTE getChannel() const;
void setChannel(UBYTE x);
UBYTE getDataType() const
void setDataType(UBYTE x);
UBYTE getTLVCount() const ;
void setTLVCount(UBYTE x);
const UBYTE *getData() ;
UBYTE *getData();
void setData(UBYTE *x);
};
EXS API Hex Format
MESSAGE (White) |
RESPONSE (Gray) |
||
Byte |
Field Description |
Byte |
Field Description |
0 |
Frame (0xFE) |
0 |
Frame (0xFE) |
1, 2 |
Length (0x00NN) |
1, 2 |
Length (0x00NN) |
3, 4 |
Message Type (0x0128) |
3, 4 |
Message Type (0x0128) |
5 |
Reserved (0x00) |
5 |
Reserved (0x00) |
6 |
Sequence Number |
6 |
Same Sequence Number |
7 |
Logical Node ID |
7 |
Logical Node ID |
8, 9 |
|||
8 : |
AIB Address Method 0x00 - Individual AEs |
10
|
AIB (same as message) |
Number of AEs to follow |
|||
AE |
|||
: |
Data Type 0x00 TLVs |
: |
Data Type 0x00 TLVs |
: |
Number of TLVs to Follow |
: |
Number of TLVs to Follow |
: |
: |
: |
: |
: |
Checksum |
: |
Checksum |