rcdiscover::SocketLinux Class Reference

Socket implementation for Linux. More...

#include <socket_linux.h>

Inheritance diagram for rcdiscover::SocketLinux:

Public Types
typedef int	SocketType
	Type representing the native socket handle type. More...

Public Member Functions
const sockaddr_in &	getDestSockAddr () const
	Returns the sockaddr to which the socket is bound. More...
SocketLinux &	operator= (SocketLinux &&other)
	SocketLinux (int domain, int type, int protocol, in_addr_t dst_ip, uint16_t port, std::string iface_name)
	Constructor. More...
	SocketLinux (SocketLinux &&other)
	~SocketLinux ()
Public Member Functions inherited from rcdiscover::Socket< SocketLinux >
void	bind (const sockaddr_in &addr)
	Binds the socket to an interface. More...
void	enableBroadcast ()
	Enables broadcast for this socket. More...
void	enableNonBlocking ()
	Enables non-blocking operation for this socket. More...
const T &	getHandle () const
	Returns the native socket handle. More...
const std::string &	getIfaceName () const
	Returns the interface name. More...
Socket &	operator= (const Socket &)=delete
Socket &	operator= (Socket &&)=default
void	send (const std::vector< uint8_t > &sendbuf)
	Sends data. More...
	Socket (const Socket &)=delete
	Socket (Socket &&)=default
	Socket (std::string iface_name)

Static Public Member Functions
static SocketLinux	create (in_addr_t dst_ip, uint16_t port, std::string iface_name)
	Create a new socket. More...
static std::vector< SocketLinux >	createAndBindForAllInterfaces (uint16_t port)
	Creates sockets for all interfaces and binds them to the respective interface. More...
static const in_addr_t &	getBroadcastAddr ()
	Returns the broadcast address. More...

Protected Member Functions
void	bindImpl (const sockaddr_in &addr)
	Binds the socket to a specific sockaddr. More...
void	enableBroadcastImpl ()
	Enables broadcast for this socket. More...
void	enableNonBlockingImpl ()
	Enables non-blocking operation for this socket. More...
const int &	getHandleImpl () const
	Returns the native socket handle. More...
void	sendImpl (const std::vector< uint8_t > &sendbuf)
	Sends data. More...

Private Member Functions
void	bindToDevice (const std::string &device)
	Binds this socket to a specific device (root privileges are required). More...

Private Attributes
sockaddr_in	dst_addr_
int	sock_

Friends
class	Socket< SocketLinux >

Detailed Description

Socket implementation for Linux.

Definition at line 51 of file socket_linux.h.

Member Typedef Documentation

SocketType

typedef int rcdiscover::SocketLinux::SocketType

Type representing the native socket handle type.

Definition at line 59 of file socket_linux.h.

Constructor & Destructor Documentation

SocketLinux() [1/2]

rcdiscover::SocketLinux::SocketLinux	(	int	domain,
		int	type,
		int	protocol,
		in_addr_t	dst_ip,
		uint16_t	port,
		std::string	iface_name
	)

Constructor.

Parameters

domain	domain of socket()
type	type of socket()
protocol	protocol of socket()
dst_ip	destination IP address
port	destination port
iface_name	name of the interface

Definition at line 162 of file socket_linux.cc.

SocketLinux() [2/2]

rcdiscover::SocketLinux::SocketLinux

(

SocketLinux &&

other

)

Definition at line 195 of file socket_linux.cc.

~SocketLinux()

rcdiscover::SocketLinux::~SocketLinux

(

)

Definition at line 209 of file socket_linux.cc.

Member Function Documentation

bindImpl()

void rcdiscover::SocketLinux::bindImpl ( const sockaddr_in &  addr )

protected

Binds the socket to a specific sockaddr.

Parameters

addr	sockaddr_in to which to bind the socket

Definition at line 222 of file socket_linux.cc.

bindToDevice()

void rcdiscover::SocketLinux::bindToDevice ( const std::string &  device )

private

Binds this socket to a specific device (root privileges are required).

Parameters

device

device name to bind the socket to

Exceptions

OperationNotPermitted

in case this function is called without root privileges

Definition at line 273 of file socket_linux.cc.

create()

SocketLinux rcdiscover::SocketLinux::create ( in_addr_t  dst_ip, uint16_t  port, std::string  iface_name  )

static

Create a new socket.

Parameters

dst_ip	destination IP address
port	destination port
iface_name	name of the interface

Returns

the created socket

Definition at line 69 of file socket_linux.cc.

createAndBindForAllInterfaces()

std::vector< SocketLinux > rcdiscover::SocketLinux::createAndBindForAllInterfaces ( uint16_t  port )

static

Creates sockets for all interfaces and binds them to the respective interface.

Parameters

port	destination port

Returns

vector of sockets

Definition at line 76 of file socket_linux.cc.

enableBroadcastImpl()

void rcdiscover::SocketLinux::enableBroadcastImpl ( )

protected

Enables broadcast for this socket.

Definition at line 251 of file socket_linux.cc.

enableNonBlockingImpl()

void rcdiscover::SocketLinux::enableNonBlockingImpl ( )

protected

Enables non-blocking operation for this socket.

Definition at line 264 of file socket_linux.cc.

getBroadcastAddr()

const in_addr_t & rcdiscover::SocketLinux::getBroadcastAddr ( )

static

Returns the broadcast address.

Returns

broadcast address

Definition at line 58 of file socket_linux.cc.

getDestSockAddr()

const sockaddr_in & rcdiscover::SocketLinux::getDestSockAddr

(

)

const

Returns the sockaddr to which the socket is bound.

Returns

sockaddr to which the socket is bound.

Definition at line 64 of file socket_linux.cc.

getHandleImpl()

const int & rcdiscover::SocketLinux::getHandleImpl ( ) const

protected

Returns the native socket handle.

Returns

native socket handle.

Definition at line 217 of file socket_linux.cc.

operator=()

SocketLinux & rcdiscover::SocketLinux::operator=

(

SocketLinux &&

other

)

Definition at line 203 of file socket_linux.cc.

sendImpl()

void rcdiscover::SocketLinux::sendImpl ( const std::vector< uint8_t > &  sendbuf )

protected

Sends data.

Parameters

sendbuf

data buffer

Definition at line 232 of file socket_linux.cc.

Friends And Related Function Documentation

Socket< SocketLinux >

friend class Socket< SocketLinux >

friend

Definition at line 53 of file socket_linux.h.

Member Data Documentation

dst_addr_

sockaddr_in rcdiscover::SocketLinux::dst_addr_

private

Definition at line 148 of file socket_linux.h.

sock_

int rcdiscover::SocketLinux::sock_

private

Definition at line 147 of file socket_linux.h.

---

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

• socket_linux.h
• socket_linux.cc