NimBLEConnInfo.h

/*
 * Copyright 2020-2025 Ryan Powell <ryan@nable-embedded.io> and
 * esp-nimble-cpp, NimBLE-Arduino contributors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
 
#ifndef NIMBLE_CPP_CONNINFO_H_
#define NIMBLE_CPP_CONNINFO_H_
 
#if defined(CONFIG_NIMBLE_CPP_IDF)
# include "host/ble_gap.h"
#else
# include "nimble/nimble/host/include/host/ble_gap.h"
#endif
 
#include "NimBLEAddress.h"
#include <cstdio>
 
class NimBLEConnInfo {
  public:
    NimBLEAddress getAddress() const { return NimBLEAddress(m_desc.peer_ota_addr); }
 
    NimBLEAddress getIdAddress() const { return NimBLEAddress(m_desc.peer_id_addr); }
 
    uint16_t getConnHandle() const { return m_desc.conn_handle; }
 
    uint16_t getConnInterval() const { return m_desc.conn_itvl; }
 
    uint16_t getConnTimeout() const { return m_desc.supervision_timeout; }
 
    uint16_t getConnLatency() const { return m_desc.conn_latency; }
 
    uint16_t getMTU() const { return ble_att_mtu(m_desc.conn_handle); }
 
    bool isMaster() const { return (m_desc.role == BLE_GAP_ROLE_MASTER); }
 
    bool isSlave() const { return (m_desc.role == BLE_GAP_ROLE_SLAVE); }
 
    bool isBonded() const { return (m_desc.sec_state.bonded == 1); }
 
    bool isEncrypted() const { return (m_desc.sec_state.encrypted == 1); }
 
    bool isAuthenticated() const { return (m_desc.sec_state.authenticated == 1); }
 
    uint8_t getSecKeySize() const { return m_desc.sec_state.key_size; }
 
    std::string toString() const {
        std::string str;
        // 294 chars max expected from all labels + worst-case values, round up to 300.
        str.resize(300);
 
        snprintf(&str[0],
                 str.size(),
                 "  Address: %s\n"
                 "  ID Address: %s\n"
                 "  Connection Handle: %u\n"
                 "  Connection Interval: %.1f ms\n"
                 "  Connection Timeout: %u ms\n"
                 "  Connection Latency: %u\n"
                 "  MTU: %u bytes\n"
                 "  Role: %s\n"
                 "  Bonded: %s\n"
                 "  Encrypted: %s\n"
                 "  Authenticated: %s\n"
                 "  Security Key Size: %u\n",
                 getAddress().toString().c_str(),
                 getIdAddress().toString().c_str(),
                 getConnHandle(),
                 getConnInterval() * 1.25f,
                 getConnTimeout() * 10,
                 getConnLatency(),
                 getMTU(),
                 isMaster() ? "Master" : "Slave",
                 isBonded() ? "Yes" : "No",
                 isEncrypted() ? "Yes" : "No",
                 isAuthenticated() ? "Yes" : "No",
                 getSecKeySize());
        return str;
    }
 
  private:
    friend class NimBLEServer;
    friend class NimBLEClient;
    friend class NimBLECharacteristic;
    friend class NimBLEDescriptor;
 
    ble_gap_conn_desc m_desc{};
    NimBLEConnInfo() {};
    NimBLEConnInfo(ble_gap_conn_desc desc) { m_desc = desc; }
};
 
#endif // NIMBLE_CPP_CONNINFO_H_