Open Model Railroad Network (OpenMRN)
Loading...
Searching...
No Matches
ble::Connection Class Reference

Connection instance metadata. More...

#include <Connection.hxx>

Public Member Functions

Defs::ConnHandle get_handle ()
 Get the connection handle.
 
void get_addr (Defs::Addr addr, Defs::AddrType *addr_type)
 Get the connection address.
 
 ~Connection ()
 Destructor. This happens when there is a disconnect.
 

Private Member Functions

 Connection (Defs::ConnHandle handle, Defs::Addr addr, Defs::AddrType addr_type, bool central)
 Constructor.
 

Private Attributes

Defs::ConnHandle handle_
 handle to the connection
 
Defs::Addr addr_
 peer address
 
Defs::AddrType addrType_
 peer address type
 
bool central_
 true if central role, else peripheral role
 

Friends

class Connections
 Allow private access from Connections container object.
 

Detailed Description

Connection instance metadata.

Definition at line 45 of file Connection.hxx.

Constructor & Destructor Documentation

◆ ~Connection()

ble::Connection::~Connection ( )
inline

Destructor. This happens when there is a disconnect.

Definition at line 67 of file Connection.hxx.

◆ Connection()

ble::Connection::Connection ( Defs::ConnHandle  handle,
Defs::Addr  addr,
Defs::AddrType  addr_type,
bool  central 
)
inlineprivate

Constructor.

Parameters
handlehandle to the connection
addrpeer address
addr_typepeer address type
centraltrue if central role, else peripheral role

Definition at line 77 of file Connection.hxx.

Member Function Documentation

◆ get_addr()

void ble::Connection::get_addr ( Defs::Addr  addr,
Defs::AddrType addr_type 
)
inline

Get the connection address.

Returns
connection address

Definition at line 57 of file Connection.hxx.

◆ get_handle()

Defs::ConnHandle ble::Connection::get_handle ( )
inline

Get the connection handle.

Returns
connection handle

Definition at line 50 of file Connection.hxx.

Friends And Related Symbol Documentation

◆ Connections

friend class Connections
friend

Allow private access from Connections container object.

Definition at line 92 of file Connection.hxx.

Member Data Documentation

◆ addr_

Defs::Addr ble::Connection::addr_
private

peer address

Definition at line 87 of file Connection.hxx.

◆ addrType_

Defs::AddrType ble::Connection::addrType_
private

peer address type

Definition at line 88 of file Connection.hxx.

◆ central_

bool ble::Connection::central_
private

true if central role, else peripheral role

Definition at line 89 of file Connection.hxx.

◆ handle_

Defs::ConnHandle ble::Connection::handle_
private

handle to the connection

Definition at line 86 of file Connection.hxx.


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