join::BasicLinkLayerEndpoint< Protocol > Class Template Reference

basic link layer endpoint class. More...

#include <endpoint.hpp>

Inheritance diagram for join::BasicLinkLayerEndpoint< Protocol >:

Collaboration diagram for join::BasicLinkLayerEndpoint< Protocol >:

Public Member Functions
	BasicLinkLayerEndpoint () noexcept
	default constructor.
	BasicLinkLayerEndpoint (const struct sockaddr *addr, socklen_t len) noexcept
	create instance using socket address.
	BasicLinkLayerEndpoint (const char *dev) noexcept
	create instance using device name.
	BasicLinkLayerEndpoint (const std::string &dev) noexcept
	create instance using device name.
constexpr Protocol	protocol () const noexcept
	get endpoint protocol.
constexpr socklen_t	length () const noexcept
	get socket address length.
void	device (const std::string &dev) noexcept
	set endpoint device name.
std::string	device () const
	get endpoint device name.
Public Member Functions inherited from join::BasicEndpoint< Protocol >
constexpr	BasicEndpoint () noexcept
	default constructor.
	BasicEndpoint (const struct sockaddr *addr, socklen_t len) noexcept
	create instance using socket address.
struct sockaddr *	addr () noexcept
	get socket address.
const struct sockaddr *	addr () const noexcept
	get socket address.

Additional Inherited Members
Protected Attributes inherited from join::BasicEndpoint< Protocol >
struct sockaddr_storage	_addr = {}
	socket address storage.

Detailed Description

template<class Protocol>
class join::BasicLinkLayerEndpoint< Protocol >

basic link layer endpoint class.

Constructor & Destructor Documentation

BasicLinkLayerEndpoint() [1/4]

template<class Protocol >

join::BasicLinkLayerEndpoint< Protocol >::BasicLinkLayerEndpoint ( )

inlinenoexcept

default constructor.

BasicLinkLayerEndpoint() [2/4]

template<class Protocol >

join::BasicLinkLayerEndpoint< Protocol >::BasicLinkLayerEndpoint ( const struct sockaddr * addr, socklen_t len )

inlinenoexcept

create instance using socket address.

Parameters

addr	socket address.
len	socket address length.

BasicLinkLayerEndpoint() [3/4]

template<class Protocol >

join::BasicLinkLayerEndpoint< Protocol >::BasicLinkLayerEndpoint ( const char * dev )

inlinenoexcept

create instance using device name.

Parameters

dev	device name to set.

BasicLinkLayerEndpoint() [4/4]

template<class Protocol >

join::BasicLinkLayerEndpoint< Protocol >::BasicLinkLayerEndpoint ( const std::string & dev )

inlinenoexcept

create instance using device name.

Parameters

dev	device name to set.

Member Function Documentation

device() [1/2]

template<class Protocol >

std::string join::BasicLinkLayerEndpoint< Protocol >::device ( ) const

inline

get endpoint device name.

Returns

endpoint device name.

device() [2/2]

template<class Protocol >

void join::BasicLinkLayerEndpoint< Protocol >::device ( const std::string & dev )

inlinenoexcept

set endpoint device name.

Parameters

dev	device name to set.

length()

template<class Protocol >

socklen_t join::BasicLinkLayerEndpoint< Protocol >::length ( ) const

inlineconstexprnoexcept

get socket address length.

Returns

socket address length.

protocol()

template<class Protocol >

Protocol join::BasicLinkLayerEndpoint< Protocol >::protocol ( ) const

inlineconstexprnoexcept

get endpoint protocol.

Returns

endpoint protocol.

---

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

• core/include/join/endpoint.hpp