BsdSockets::LocalAddress Class Reference

Local Socket Address (formerly Unix Domain Socket) Address representing a named pipe's name. More...

#include <LocalAddress.h>

Inheritance diagram for BsdSockets::LocalAddress:

Collaboration diagram for BsdSockets::LocalAddress:

Public Types
typedef std::shared_ptr< LocalAddress >	Ptr
Public Types inherited from BsdSockets::Address
typedef std::shared_ptr< Address >	Ptr

Public Member Functions
virtual	~LocalAddress ()
const std::string &	getPath () const
virtual std::shared_ptr< LowLevelAddress >	makeTempLowLevelAddress () const
virtual Address::Ptr	create (std::shared_ptr< LowLevelAddress > lowLevelAddress) const
virtual LowLevelAddress &	getLowLevelAddress () const
Public Member Functions inherited from BsdSockets::Address
virtual	~Address ()
SocketDomain	getSocketDomain () const
SocketType	getSocketType () const
int	getProtocol () const

Static Public Member Functions
static LocalAddress::Ptr	create (const std::string &thePath)

Additional Inherited Members
Protected Member Functions inherited from BsdSockets::Address
	Address (SocketDomain theSocketDomain, SocketType theSocketType, int theProtocol)
	Address (const Address &rhs)

Detailed Description

Local Socket Address (formerly Unix Domain Socket) Address representing a named pipe's name.

Definition at line 35 of file LocalAddress.h.

Member Typedef Documentation

Ptr

typedef std::shared_ptr<LocalAddress> BsdSockets::LocalAddress::Ptr

Examples

LocalAddressExamples.cpp.

Definition at line 37 of file LocalAddress.h.

Constructor & Destructor Documentation

~LocalAddress()

BsdSockets::LocalAddress::~LocalAddress ( )

virtual

Virtual destructor to support derived classes

Definition at line 71 of file LocalAddress.cpp.

Member Function Documentation

create() [1/2]

LocalAddress::Ptr BsdSockets::LocalAddress::create ( const std::string &  thePath )

static

Create from thePath string

Parameters

thePath

path to create from, cannot be empty, must be shorter than the unspecified maximum length for this system.

Returns

LocalAddress created

Examples

LocalAddressExamples.cpp.

Definition at line 67 of file LocalAddress.cpp.

create() [2/2]

Address::Ptr BsdSockets::LocalAddress::create ( std::shared_ptr< LowLevelAddress >  lowLevelAddress ) const

virtual

Create a new Address from a LowLevelAddress using this Address as a template.

Parameters

lowLevelAddress

data to create from

Returns

Address created

Implements BsdSockets::Address.

Definition at line 91 of file LocalAddress.cpp.

getLowLevelAddress()

LowLevelAddress & BsdSockets::LocalAddress::getLowLevelAddress ( ) const

virtual

Method for derived classes to provide access to the LowLevelAddress information

Implements BsdSockets::Address.

Definition at line 100 of file LocalAddress.cpp.

getPath()

const std::string & BsdSockets::LocalAddress::getPath

(

)

const

Returns

the path of this LocalAddress

Definition at line 83 of file LocalAddress.cpp.

makeTempLowLevelAddress()

LowLevelAddress::Ptr BsdSockets::LocalAddress::makeTempLowLevelAddress ( ) const

virtual

Returns

a LowLevelAddress suitable for create()

Implements BsdSockets::Address.

Definition at line 87 of file LocalAddress.cpp.

---

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

• include/LocalAddress.h
• src/LocalAddress.cpp