doc_basic_endpoint.md

Header file basic_endpoint.hpp

namespace canary
{
    template <class Protocol>
    class basic_endpoint;
}

Class canary::basic_endpoint

template <class Protocol>
class basic_endpoint
{
public:
    using protocol_type = Protocol;

    using data_type = ::sockaddr;

    basic_endpoint();

    basic_endpoint(unsigned int interface_index);

    protocol_type protocol() const noexcept;

    unsigned int interface_index() const noexcept;

    data_type* data() noexcept;

    data_type* data() const noexcept;

    std::size_t size() const noexcept;

    std::size_t capacity() const noexcept;

    void resize(std::size_t n);
};

Describes an endpoint for a CAN bus interface that can be bound to a CAN socket.

Type alias canary::basic_endpoint::protocol_type

using protocol_type = Protocol;

The protocol type associated with the endpoint.

---

Type alias canary::basic_endpoint::data_type

using data_type = ::sockaddr;

Underlying type used to store the endpoint information.

---

Constructor canary::basic_endpoint::basic_endpoint

basic_endpoint();

Default constructor

---

Constructor canary::basic_endpoint::basic_endpoint

basic_endpoint(unsigned int interface_index);

Construct an endpoint that represents a particular CAN interface index.

---

Function canary::basic_endpoint::protocol

protocol_type protocol() const noexcept;

Constructs an object of the protocol type associated with this endpoint.

---

Function canary::basic_endpoint::interface_index

unsigned int interface_index() const noexcept;

Returns the interface index that this endpoint represents.

---

Function canary::basic_endpoint::data

data_type* data() noexcept;

Get the underlying endpoint in the native type.

---

Function canary::basic_endpoint::data

data_type* data() const noexcept;

Get the underlying endpoint in the native type.

---

Function canary::basic_endpoint::size

std::size_t size() const noexcept;

Get the underlying size of the endpoint in the native type.

---

Function canary::basic_endpoint::capacity

std::size_t capacity() const noexcept;

Get the underlying capacity of the endpoint in the native type.

---

Function canary::basic_endpoint::resize

void resize(std::size_t n);

Set the underlying size of the endpoint in the native type.

---

---