Unix socket. More...

#include <sock.h>

Inheritance diagram for SockUnix:

Collaboration diagram for SockUnix:

Public Member Functions
const std::string &	getPeerAddress () const

const char *	getPeerAddress_c () const

bool	isPeerAddressAbstract () const

bool	setPeerAddress (const std::string &string, bool useAbstract=false)

bool	setPeerAddress (const ConfigFile &cfg, const std::string &section="")

const std::string &	getSelfAddress () const

const char *	getSelfAddress_c () const

bool	isSelfAddressAbstract () const

bool	setSelfAddress (const std::string &string, bool useAbstract=false)

bool	setDefSelfAddress (const std::string &rootBase="", const std::string &useDef="")

bool	sendTo (const void *msg, size_t len, const std::string &addrStr, bool useAbstract=false) const

bool	sendTo (const Buf &buf, size_t len, const std::string &addrStr, bool useAbstract=false) const

ssize_t	rcvFrom (void *buf, size_t bufSize, std::string &from, bool block=false) const

ssize_t	rcvFrom (Buf &buf, std::string &from, bool block=false) const

ssize_t	rcvFrom (void *buf, size_t bufSize, bool block=false)

ssize_t	rcvFrom (Buf &buf, bool block=false)

ssize_t	rcvBufFrom (Buf &buf, bool block=false)

const std::string &	getLastFrom () const

const char *	getLastFrom_c () const

bool	isLastFromAbstract () const

Public Member Functions inherited from SockBase
virtual	~SockBase ()

void	close ()

bool	init ()

bool	send (const void *msg, size_t len) const

bool	send (const Buf &buf, size_t len) const

bool	sendBuf (const Buf &buf, size_t len) const

ssize_t	rcv (void *buf, size_t bufSize, bool block=false) const

ssize_t	rcv (Buf &buf, bool block=false) const

ssize_t	rcvBuf (Buf &buf, bool block=false) const

int	getFd () const

int	fileno () const

bool	poll (uint64_t timeout_ms=0) const

bool	tpoll (uint64_t &timeout_ms) const

Static Public Member Functions
static const std::string &	getHomeDir ()

static const char *	getHomeDir_c ()

static bool	isAddressAbstract (const std::string &addr)

Detailed Description

Unix socket.

provide Unix socket that can be used to communicate with linuxptp daemon, ptp4l.

Member Function Documentation

◆ getHomeDir()

static const std::string & SockUnix::getHomeDir ( )

static

Get user home directory

Returns: string object with home directory

◆ getHomeDir_c()

static const char * SockUnix::getHomeDir_c ( )

static

Get user home directory

Returns: string with home directory

◆ getLastFrom()

const std::string & SockUnix::getLastFrom ( ) const

Fetch origin address from last rcvFrom() call

Returns: Unix socket address

Note: store address only on the rcvFrom() call without the from parameter

Attention: no protection or thread safe, fetch last rcvFrom() call with this object.

◆ getLastFrom_c()

const char * SockUnix::getLastFrom_c ( ) const

Fetch origin address from last rcvFrom() call

Returns: Unix socket address

Note: store address only on the rcvFrom() call without the from parameter

Attention: no protection or thread safe, fetch last rcvFrom() call with this object.

◆ getPeerAddress()

const std::string & SockUnix::getPeerAddress ( ) const

Get peer address

Returns: string object with peer address

◆ getPeerAddress_c()

const char * SockUnix::getPeerAddress_c ( ) const

Get peer address

Returns: string with peer address

◆ getSelfAddress()

const std::string & SockUnix::getSelfAddress ( ) const

Get self address

Returns: string object with self address

◆ getSelfAddress_c()

const char * SockUnix::getSelfAddress_c ( ) const

Get self address

Returns: string with self address

◆ isAddressAbstract()

static bool SockUnix::isAddressAbstract ( const std::string & addr )

static

Is address abstract?

Parameters

[in] addr socket address

Returns: true if address is abstract address

◆ isLastFromAbstract()

bool SockUnix::isLastFromAbstract ( ) const

Is last from address abstract?

Returns: true if last from address is abstract address

◆ isPeerAddressAbstract()

bool SockUnix::isPeerAddressAbstract ( ) const

Is peer address abstract?

Returns: true if peer address is abstract address

◆ isSelfAddressAbstract()

bool SockUnix::isSelfAddressAbstract ( ) const

Is self address abstract?

Returns: true if self address is abstract address

◆ rcvBufFrom()

ssize_t SockUnix::rcvBufFrom	(	Buf &	buf,
		bool	block = `false`
	)

Receive a message using the socket from any address

Parameters

[in]	buf	object with message memory buffer
[in]	block	true, wait till a packet arrives. false, do not wait, return error if no packet available

Returns: number of bytes received or negative on failure

Note: use getLastFrom() to fetch origin address which send the packet; identical to rcvFrom(). Some scripts fail to match proper function.

◆ rcvFrom() [1/4]

ssize_t SockUnix::rcvFrom	(	Buf &	buf,
		bool	block = `false`
	)

Receive a message using the socket from any address

Parameters

[in]	buf	object with message memory buffer
[in]	block	true, wait till a packet arrives. false, do not wait, return error if no packet available

Returns: number of bytes received or negative on failure

Note: use getLastFrom() to fetch origin address which send the packet

◆ rcvFrom() [2/4]

ssize_t SockUnix::rcvFrom	(	Buf &	buf,
		std::string &	from,
		bool	block = `false`
	)		const

Receive a message using the socket from any address

Parameters

[in]	buf	object with message memory buffer
[out]	from	Unix socket address (socket file)
[in]	block	true, wait till a packet arrives. false, do not wait, return error if no packet available

Returns: number of bytes received or negative on failure

Note: from store the origin address which send the packet

◆ rcvFrom() [3/4]

ssize_t SockUnix::rcvFrom	(	void *	buf,
		size_t	bufSize,
		bool	block = `false`
	)

Receive a message using the socket from any address

Parameters

[in,out]	buf	pointer to a memory buffer
[in]	bufSize	memory buffer size
[in]	block	true, wait till a packet arrives. false, do not wait, return error if no packet available

Returns: number of bytes received or negative on failure

Note: use getLastFrom() to fetch origin address which send the packet

◆ rcvFrom() [4/4]

ssize_t SockUnix::rcvFrom	(	void *	buf,
		size_t	bufSize,
		std::string &	from,
		bool	block = `false`
	)		const

Receive a message using the socket from any address

Parameters

[in,out]	buf	pointer to a memory buffer
[in]	bufSize	memory buffer size
[out]	from	Unix socket address (socket file)
[in]	block	true, wait till a packet arrives. false, do not wait, return error if no packet available

Returns: number of bytes received or negative on failure

Note: from store the origin address which send the packet

◆ sendTo() [1/2]

bool SockUnix::sendTo	(	const Buf &	buf,
		size_t	len,
		const std::string &	addrStr,
		bool	useAbstract = `false`
	)		const

Send the message using the socket to a specific address

Parameters

[in]	buf	object with message memory buffer
[in]	len	message length
[in]	addrStr	Unix socket address (socket file)
[in]	useAbstract	use Abstract socket address

Returns: true if message is sent

Note: true does NOT guarantee the frame was successfully arrives its target. Only the network layer sends it.; useAbstract add '0' byte at the start of the address to mark it as abstract socket address

◆ sendTo() [2/2]

bool SockUnix::sendTo	(	const void *	msg,
		size_t	len,
		const std::string &	addrStr,
		bool	useAbstract = `false`
	)		const

Send the message using the socket to a specific address

Parameters

[in]	msg	pointer to message memory buffer
[in]	len	message length
[in]	addrStr	Unix socket address (socket file)
[in]	useAbstract	use Abstract socket address

Returns: true if message is sent

Note: true does NOT guarantee the frame was successfully arrives its target. Only the network layer sends it.; useAbstract add '0' byte at the start of the address to mark it as abstract socket address

◆ setDefSelfAddress()

bool SockUnix::setDefSelfAddress	(	const std::string &	rootBase = `""`,
		const std::string &	useDef = `""`
	)

Set self address using predefined algorithm

Parameters

[in]	rootBase	base used for root user
[in]	useDef	base used for non root user

Returns: true if self address is updated

Note: address can not be changed after initializing. User can close the socket, change this value, and initialize a new socket.

◆ setPeerAddress() [1/2]

bool SockUnix::setPeerAddress	(	const ConfigFile &	cfg,
		const std::string &	section = `""`
	)

Set peer address using configuration file

Parameters

[in]	cfg	reference to configuration file object
[in]	section	in configuration file

Returns: true if peer address is updated

Note: calling without section will fetch value from "global" section

◆ setPeerAddress() [2/2]

bool SockUnix::setPeerAddress	(	const std::string &	string,
		bool	useAbstract = `false`
	)

Set peer address

Parameters

[in]	string	object with peer address
[in]	useAbstract	use Abstract socket address

Returns: true if peer address is updated

Note: useAbstract add '0' byte at the start of the address to mark it as abstract socket address

◆ setSelfAddress()

bool SockUnix::setSelfAddress	(	const std::string &	string,
		bool	useAbstract = `false`
	)

Set self address

Parameters

[in]	string	object with self address
[in]	useAbstract	use Abstract socket address

Returns: true if self address is updated

Note: address can not be changed after initializing. User can close the socket, change this value, and initialize a new socket.; useAbstract add '0' byte at the start of the address to mark it as abstract socket address

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

pub/sock.h

Public Member Functions

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ getHomeDir()

◆ getHomeDir_c()

◆ getLastFrom()

◆ getLastFrom_c()

◆ getPeerAddress()

◆ getPeerAddress_c()

◆ getSelfAddress()

◆ getSelfAddress_c()

◆ isAddressAbstract()

◆ isLastFromAbstract()

◆ isPeerAddressAbstract()

◆ isSelfAddressAbstract()

◆ rcvBufFrom()

◆ rcvFrom() [1/4]

◆ rcvFrom() [2/4]

◆ rcvFrom() [3/4]

◆ rcvFrom() [4/4]

◆ sendTo() [1/2]

◆ sendTo() [2/2]

◆ setDefSelfAddress()

◆ setPeerAddress() [1/2]

◆ setPeerAddress() [2/2]

◆ setSelfAddress()