Isup.decode
From Yate Documentation
(Difference between revisions)
(Created page with " '''isup.decode''' is a message sent by a module wishing to decode a buffer containing an ISUP message === Parameters === '''message-prefix''' :::Optional string indicating ...") |
|||
| (4 intermediate revisions by one user not shown) | |||
| Line 16: | Line 16: | ||
message-prefix=isup. | message-prefix=isup. | ||
| + | |||
The other parameters must be: | The other parameters must be: | ||
| − | isup.protocol-type= | + | |
| + | isup.protocol-type= | ||
| + | |||
isup.protocol-basetype= | isup.protocol-basetype= | ||
| − | On return the message parameters will look like: | + | |
| − | isup.message-type=IAM | + | On return the message parameters will look like: |
| − | isup.CallingPartyNumber=some-number | + | |
| + | isup.message-type=IAM | ||
| + | |||
| + | isup.CallingPartyNumber=some-number | ||
==== Return ==== | ==== Return ==== | ||
True if the message was succesfully decoded. The message's parameter list will be filled with the decoded ISUP parameters and the "message-type" parameter will be filled with the ISUP message type. | True if the message was succesfully decoded. The message's parameter list will be filled with the decoded ISUP parameters and the "message-type" parameter will be filled with the ISUP message type. | ||
| − | False on decoding failure. The message's parameter list may contain an incomplete ISUP message | + | False on decoding failure. The message's parameter list may contain an incomplete ISUP message. |
| + | |||
| + | |||
| + | '''See also''' | ||
| + | |||
| + | * [[isup.encode]] | ||
Latest revision as of 14:53, 21 January 2013
isup.decode is a message sent by a module wishing to decode a buffer containing an ISUP message
[edit] Parameters
message-prefix
- Optional string indicating the prefix for 'protocol-type' and 'protocol-basetype' parameters and for all decoded parameters
protocol-type
- Keyword indicating the encoding standard used to create the data buffer to decode: itu-t, ansi
protocol-basetype
- Additional information about the encoding standard to be used when the protocol-type might indicate an unknown/unsupported encoding standard
rawdata
- Named pointer containing a data block buffer with the ISUP message to decode. The data buffer must contain the ISUP message starting from the message type byte
[edit] Example of message-prefix
message-prefix=isup.
The other parameters must be:
isup.protocol-type=
isup.protocol-basetype=
On return the message parameters will look like:
isup.message-type=IAM
isup.CallingPartyNumber=some-number
[edit] Return
True if the message was succesfully decoded. The message's parameter list will be filled with the decoded ISUP parameters and the "message-type" parameter will be filled with the ISUP message type. False on decoding failure. The message's parameter list may contain an incomplete ISUP message.
See also
