Improved SCCPUser methods documentation.
git-svn-id: http://yate.null.ro/svn/yate/trunk@5258 acf43c95-373e-0410-b603-e72c3f656dc1
This commit is contained in:
parent
206710225e
commit
8a17864fab
|
@ -5310,7 +5310,22 @@ public:
|
||||||
virtual bool sendData(DataBlock& data, NamedList& params);
|
virtual bool sendData(DataBlock& data, NamedList& params);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Send a request/ notification to sccp regarding a subsystem status
|
* \verbatim
|
||||||
|
Send a request/ notification from users to sccp regarding a subsystem status
|
||||||
|
Type : CoordinateRequest -> Request from a user to sccp to go OOS
|
||||||
|
params: "ssn" The ssn to go OOS
|
||||||
|
"smi" Subsystem multiplicity indicator
|
||||||
|
"backups" The number of backup subsystems
|
||||||
|
"backup.N.ssn" The ssn of the backup subsystem number N
|
||||||
|
"backup.N.pointcode" The ssn of the backup subsystem number N
|
||||||
|
Type : CoordinateResponse -> Indication from a user to sccp in response to CoordinateIndication<
|
||||||
|
params: "ssn" The subsystem number that approved the indication
|
||||||
|
"smi" 0
|
||||||
|
Type : StatusRequest -> Request from user to sccp to update a subsystem status
|
||||||
|
params: "ssn" The affected subsystem number
|
||||||
|
"smi" 0;
|
||||||
|
"subsystem-status": The requested status: UserOutOfService, UserInService
|
||||||
|
\endverbatim
|
||||||
* @param type The type of request / notification
|
* @param type The type of request / notification
|
||||||
* @param params List of parameters
|
* @param params List of parameters
|
||||||
* @return True if sccp management has processed the request / notification.
|
* @return True if sccp management has processed the request / notification.
|
||||||
|
@ -5335,7 +5350,19 @@ public:
|
||||||
virtual HandledMSU notifyData(DataBlock& data, NamedList& params);
|
virtual HandledMSU notifyData(DataBlock& data, NamedList& params);
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Notification from SCCP management about pointcodes status, OOS responses/indications, subsystems status
|
* \verbatim
|
||||||
|
Notification from SCCP management to a sccp user about pointcodes status, OOS responses/indications, subsystems status
|
||||||
|
Type: CoordinateIndication -> Indication from a remote SCCP User that requires to go OOS
|
||||||
|
params: ssn -> The subsystem number of the remote SCCP User
|
||||||
|
smi -> Subsystem multiplicity indicator
|
||||||
|
pointcode -> The pointcode of the remote SCCP User
|
||||||
|
Type: SubsystemStatus -> Request from SCCP Management to SCCP Users to query the specified subsystem status.
|
||||||
|
This happens when a SubsystemStatusTest(SST) message is received
|
||||||
|
params: ssn -> The requested subsystem
|
||||||
|
return params:
|
||||||
|
subsystem-status -> The status of the subsystem: UserOutOfService, UserInService
|
||||||
|
Missing = UserOutOfService
|
||||||
|
\endverbatim
|
||||||
* @param type The type of notification
|
* @param type The type of notification
|
||||||
* @param params List of parameters
|
* @param params List of parameters
|
||||||
* @return False on error
|
* @return False on error
|
||||||
|
@ -5345,7 +5372,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Attach as user to a SCCP
|
* Attach as user to a SCCP
|
||||||
* @param sccp Pointer to the SCCP to use
|
* @param sccp Pointer to the SCCP to use
|
||||||
* NOTE: This method will deref the pointer is is the same with the one that we already have!!
|
* NOTE: This method will deref the pointer if is the same with the one that we already have!!
|
||||||
* When this method is called the sccp pointer reference counter must be incremented for this
|
* When this method is called the sccp pointer reference counter must be incremented for this
|
||||||
* SCCPUser.
|
* SCCPUser.
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue