Yate
Public Types | Public Member Functions
HandledMSU Class Reference

MSU handling result codes (Q.704 15.17.5 and more) More...

#include <yatesig.h>

List of all members.

Public Types

enum  Result {
  Rejected = 0, Unequipped = 1, Inaccessible = 2, Accepted = 16,
  Failure = 17, NoAddress = 18, NoCircuit = 19
}

Public Member Functions

 HandledMSU (Result result=Rejected)
 HandledMSU (bool success)
 HandledMSU (const HandledMSU &original)
HandledMSUoperator= (Result result)
HandledMSUoperator= (const HandledMSU &original)
bool operator== (Result result)
bool operator== (const HandledMSU &result)
bool operator!= (Result result)
bool operator!= (const HandledMSU &result)
 operator Result () const
bool ok () const
unsigned char upu () const

Detailed Description

MSU handling result codes (Q.704 15.17.5 and more)

Simple inline class used to know if a MSU was handled and if not why


Constructor & Destructor Documentation

HandledMSU ( Result  result = Rejected) [inline]

Regular constructor

Parameters:
resultMSU handling result
HandledMSU ( bool  success) [inline]

Constructor from boolean success

Parameters:
successTrue signifies Accepted, false for Failure
HandledMSU ( const HandledMSU original) [inline]

Copy constructor

Parameters:
originalResult to copy

Member Function Documentation

bool ok ( ) const [inline]

Success checking

Returns:
True if MSU was handled, false for any other result
operator Result ( ) const [inline]

Result retrieval operator

Returns:
Handling result enumeration
bool operator!= ( Result  result) [inline]

Inequality operator

Parameters:
resultHandling result value to compare to
bool operator!= ( const HandledMSU result) [inline]

Inequality operator

Parameters:
resultHandling result value to compare to
HandledMSU& operator= ( Result  result) [inline]

Assignment from Result enumeration

Parameters:
resultMSU handling result
HandledMSU& operator= ( const HandledMSU original) [inline]

Assignment operator

Parameters:
originalResult to assign from
bool operator== ( Result  result) [inline]

Equality operator

Parameters:
resultHandling result value to compare to
bool operator== ( const HandledMSU result) [inline]

Equality operator

Parameters:
resultHandling result value to compare to
unsigned char upu ( ) const [inline]

Retrieve Q.704 15.17.5 UPU cause code

Returns:
UPU cause code, 0 (Unknown) for all private causes

The documentation for this class was generated from the following file: