Kenji Arai / mbed-os_TYBLE16

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependents:   TYBLE16_simple_data_logger TYBLE16_MP3_Air

Embed: (wiki syntax)

« Back to documentation index

disconnection_reason_t Struct Reference
Public Types | Public Member Functions | Friends

disconnection_reason_t Struct Reference
[Gap]

Enumeration of disconnection reasons received in a disconnection event. More...

#include <Types.h>

Inherits SafeEnum< disconnection_reason_t, uint8_t >.

Public Types

enum  type {
  AUTHENTICATION_FAILURE = 0x05, CONNECTION_TIMEOUT = 0x08, REMOTE_USER_TERMINATED_CONNECTION = 0x13, REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES = 0x14,
  REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF = 0x15, LOCAL_HOST_TERMINATED_CONNECTION = 0x16, UNACCEPTABLE_CONNECTION_PARAMETERS = 0x3B
}
 

enumeration of disconnection_reason_t values.

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

Public Member Functions

 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== (disconnection_reason_tlhs, disconnection_reason_trhs)
 Equal to operator for Target instances.
bool operator!= (disconnection_reason_tlhs, disconnection_reason_trhs)
 Not equal to operator for Target instances.
bool operator< (disconnection_reason_tlhs, disconnection_reason_trhs)
 Less than operator for Target instances.
bool operator<= (disconnection_reason_tlhs, disconnection_reason_trhs)
 Less than or equal to operator for Target instances.
bool operator> (disconnection_reason_tlhs, disconnection_reason_trhs)
 Greater than operator for Target instances.
bool operator>= (disconnection_reason_tlhs, disconnection_reason_trhs)
 Greater than or equal to operator for Target instances.

Detailed Description

Enumeration of disconnection reasons received in a disconnection event.

Definition at line 809 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 disconnection_reason_t values.

Enumerator:
AUTHENTICATION_FAILURE 

GAP or GATT failed to authenticate the peer.

CONNECTION_TIMEOUT 

The connection timed out.

REMOTE_USER_TERMINATED_CONNECTION 

Connection terminated by the user.

REMOTE_DEV_TERMINATION_DUE_TO_LOW_RESOURCES 

Remote device terminated connection due to low resources.

REMOTE_DEV_TERMINATION_DUE_TO_POWER_OFF 

Remote device terminated connection due to power off.

LOCAL_HOST_TERMINATED_CONNECTION 

Indicate that the local user or the internal Bluetooth subsystem terminated the connection.

UNACCEPTABLE_CONNECTION_PARAMETERS 

Connection parameters were unacceptable.

Definition at line 811 of file Types.h.

Constructor & Destructor Documentation

disconnection_reason_t ( type  value )

Construct a new instance of disconnection_reason_t.

Parameters:
valueThe value of the disconnection_reason_t created.

Definition at line 854 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!= ( disconnection_reason_t  lhs,
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< ( disconnection_reason_t  lhs,
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<= ( disconnection_reason_t  lhs,
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== ( disconnection_reason_t  lhs,
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> ( disconnection_reason_t  lhs,
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>= ( disconnection_reason_t  lhs,
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.

Generated on Tue Jul 12 2022 13:55:40 by  doxygen 1.7.2