Kenji Arai / mbed-os_TYBLE16

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

local_disconnection_reason_t Struct Reference

local_disconnection_reason_t Struct Reference
[Gap]

Enumeration of disconnection reasons that should be transmited to the peer. More...

#include <Types.h>

Inherits SafeEnum< local_disconnection_reason_t, uint8_t >.

Public Types

enum  type {
  AUTHENTICATION_FAILURE = 0x05, USER_TERMINATION = 0x13, LOW_RESOURCES = 0x14, POWER_OFF = 0x15,
  UNSUPPORTED_REMOTE_FEATURE = 0x1A, PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED = 0x29, UNACCEPTABLE_CONNECTION_PARAMETERS = 0x3B
}
 

enumeration of local_disconnection_reason_t values.

More...
typedef uint8_t representation_t
 Type of the representation.

Public Member Functions

 local_disconnection_reason_t (type value)
 Construct a new instance of disconnection_reason_t.
uint8_t value () const
 Explicit access to the inner value of the SafeEnum instance.
const uint8_t * storage () const
 Return a pointer to the inner storage.

Friends

bool operator== (local_disconnection_reason_tlhs, local_disconnection_reason_trhs)
 Equal to operator for Target instances.
bool operator!= (local_disconnection_reason_tlhs, local_disconnection_reason_trhs)
 Not equal to operator for Target instances.
bool operator< (local_disconnection_reason_tlhs, local_disconnection_reason_trhs)
 Less than operator for Target instances.
bool operator<= (local_disconnection_reason_tlhs, local_disconnection_reason_trhs)
 Less than or equal to operator for Target instances.
bool operator> (local_disconnection_reason_tlhs, local_disconnection_reason_trhs)
 Greater than operator for Target instances.
bool operator>= (local_disconnection_reason_tlhs, local_disconnection_reason_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Enumeration of disconnection reasons that should be transmited to the peer.

Definition at line 756 of file Types.h.


Member Typedef Documentation

typedef uint8_t representation_t [inherited]

Type of the representation.

Definition at line 113 of file SafeEnum.h.


Member Enumeration Documentation

enum type

enumeration of local_disconnection_reason_t values.

Enumerator:
AUTHENTICATION_FAILURE 

GAP or GATT failed to authenticate the peer.

USER_TERMINATION 

Connection terminated by the user.

LOW_RESOURCES 

Connection termination due to low resources.

POWER_OFF 

Connection termination due to power off.

UNSUPPORTED_REMOTE_FEATURE 

Remote feature not supported.

PAIRING_WITH_UNIT_KEY_NOT_SUPPORTED 

Not possible to pai with a unit key.

UNACCEPTABLE_CONNECTION_PARAMETERS 

Connection parameters were unacceptable.

Definition at line 758 of file Types.h.


Constructor & Destructor Documentation

Construct a new instance of disconnection_reason_t.

Parameters:
valueThe value of the local_disconnection_reason_t created.

Definition at line 800 of file Types.h.


Member Function Documentation

const uint8_t * storage (  ) const [inherited]

Return a pointer to the inner storage.

Definition at line 209 of file SafeEnum.h.

uint8_t value (  ) const [inherited]

Explicit access to the inner value of the SafeEnum instance.

Definition at line 202 of file SafeEnum.h.


Friends And Related Function Documentation

bool operator!= ( local_disconnection_reason_t  lhs,
local_disconnection_reason_t  rhs 
) [friend, inherited]

Not equal to operator for Target 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 144 of file SafeEnum.h.

bool operator< ( local_disconnection_reason_t  lhs,
local_disconnection_reason_t  rhs 
) [friend, inherited]

Less than operator for Target 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 156 of file SafeEnum.h.

bool operator<= ( local_disconnection_reason_t  lhs,
local_disconnection_reason_t  rhs 
) [friend, inherited]

Less than or equal to operator for Target 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 169 of file SafeEnum.h.

bool operator== ( local_disconnection_reason_t  lhs,
local_disconnection_reason_t  rhs 
) [friend, inherited]

Equal to operator for Target 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 131 of file SafeEnum.h.

bool operator> ( local_disconnection_reason_t  lhs,
local_disconnection_reason_t  rhs 
) [friend, inherited]

Greater than operator for Target 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 182 of file SafeEnum.h.

bool operator>= ( local_disconnection_reason_t  lhs,
local_disconnection_reason_t  rhs 
) [friend, inherited]

Greater than or equal to operator for Target 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 195 of file SafeEnum.h.