Knight KE / Mbed OS Game_Master
Embed: (wiki syntax)

« Back to documentation index

disconnection_reason_t Struct Reference

disconnection_reason_t Struct Reference

Reasons which can be used to end a connection. More...

#include <GapTypes.h>

Inherits SafeEnum< disconnection_reason_t, uint8_t >.

Public Member Functions

 disconnection_reason_t (type value)
 Construct a new disconnection_reason_t instance.
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance.

Friends

bool operator== (SafeEnum lhs, SafeEnum rhs)
 Equal to operator for SafeEnum instances.
bool operator!= (SafeEnum lhs, SafeEnum rhs)
 Not equal to operator for SafeEnum instances.
bool operator< (SafeEnum lhs, SafeEnum rhs)
 Less than operator for SafeEnum instances.
bool operator<= (SafeEnum lhs, SafeEnum rhs)
 Less than or equal to operator for SafeEnum instances.
bool operator> (SafeEnum lhs, SafeEnum rhs)
 Greater than operator for SafeEnum instances.
bool operator>= (SafeEnum lhs, SafeEnum rhs)
 Greater than or equal to operator for SafeEnum instances.

Detailed Description

Reasons which can be used to end a connection.

Definition at line 305 of file GapTypes.h.


Constructor & Destructor Documentation

disconnection_reason_t ( type  value )

Construct a new disconnection_reason_t instance.

Definition at line 319 of file GapTypes.h.


Member Function Documentation

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 196 of file SafeEnum.h.


Friends And Related Function Documentation

bool operator!= ( SafeEnum< disconnection_reason_t, uint8_t >  lhs,
SafeEnum< disconnection_reason_t, uint8_t >  rhs 
) [friend, inherited]

Not equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are not equal and false otherwise.

Definition at line 138 of file SafeEnum.h.

bool operator< ( SafeEnum< disconnection_reason_t, uint8_t >  lhs,
SafeEnum< disconnection_reason_t, uint8_t >  rhs 
) [friend, inherited]

Less than operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than rhs and false otherwise.

Definition at line 150 of file SafeEnum.h.

bool operator<= ( SafeEnum< disconnection_reason_t, uint8_t >  lhs,
SafeEnum< disconnection_reason_t, uint8_t >  rhs 
) [friend, inherited]

Less than or equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is less than or equal to rhs and false otherwise.

Definition at line 163 of file SafeEnum.h.

bool operator== ( SafeEnum< disconnection_reason_t, uint8_t >  lhs,
SafeEnum< disconnection_reason_t, uint8_t >  rhs 
) [friend, inherited]

Equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs and rhs are equal and false otherwise.

Definition at line 125 of file SafeEnum.h.

bool operator> ( SafeEnum< disconnection_reason_t, uint8_t >  lhs,
SafeEnum< disconnection_reason_t, uint8_t >  rhs 
) [friend, inherited]

Greater than operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than rhs; false otherwise.

Definition at line 176 of file SafeEnum.h.

bool operator>= ( SafeEnum< disconnection_reason_t, uint8_t >  lhs,
SafeEnum< disconnection_reason_t, uint8_t >  rhs 
) [friend, inherited]

Greater than or equal to operator for SafeEnum instances.

Parameters:
lhsleft hand side of the comparison
rhsright hand side of the comparison
Returns:
true if the inner value of lhs is greater than or equal to rhs; false otherwise.

Definition at line 189 of file SafeEnum.h.