OpenJAUS Software Development Kit  4.3.1
Public Member Functions | Static Public Member Functions | Static Protected Member Functions | Protected Attributes | Static Protected Attributes | Static Private Member Functions | Friends | List of all members
openjaus::system::Socket Class Referenceabstract

This is a brief description. More...

#include <Socket.h>

Inherited by openjaus::system::DatagramSocket, openjaus::system::MulticastSocket, and openjaus::system::StreamSocket.

Public Member Functions

 Socket ()
 
virtual ~Socket ()
 
bool isBlocking () const
 Accessor to get the value of blocking. More...
 
uint16_t getPort () const
 Accessor to get the value of port. More...
 
int getDescriptor () const
 Accessor to get the value of descriptor. More...
 
const InetAddressgetIpAddress () const
 Accessor to get the value of ipAddress. More...
 
const TimegetTimeout () const
 Accessor to get the value of timeout. More...
 
bool setTimeout (const Time &timeout)
 Accessor to set value of timeout. More...
 
const std::vector< NetworkInterface *> & getInterfaces () const
 Accessor to get the value of interfaces. More...
 
void readInterfaces ()
 Operation readInterfaces. More...
 
bool isLocalAddress (const InetAddress &ipAddress)
 Operation isLocalAddress. More...
 
uint64_t addressHash ()
 Operation addressHash. More...
 
virtual std::string toString () const
 
virtual int send (Packet &)=0
 
virtual int receive (Packet &)=0
 

Static Public Member Functions

static std::vector< NetworkInterfacelookupInterfaces ()
 

Static Protected Member Functions

static void initialize ()
 
static void deinitialize ()
 

Protected Attributes

bool blocking
 
uint16_t port
 
int descriptor
 
InetAddress ipAddress
 
Time timeout
 
std::vector< NetworkInterface *> interfaces
 

Static Protected Attributes

static int descriptorCount = 0
 

Static Private Member Functions

static bool shouldLookupBroadcastAddress (const NetworkInterface &networkInterface)
 

Friends

OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const Socket &object)
 
OPENJAUS_EXPORT friend std::ostream & operator<< (std::ostream &output, const Socket *object)
 

Detailed Description

Detailed description.

Author
Name (name@.nosp@m.emai.nosp@m.l.com)

Constructor & Destructor Documentation

§ Socket()

openjaus::system::Socket::Socket ( )

§ ~Socket()

openjaus::system::Socket::~Socket ( )
virtual

Member Function Documentation

§ addressHash()

uint64_t openjaus::system::Socket::addressHash ( )

§ deinitialize()

void openjaus::system::Socket::deinitialize ( )
staticprotected

§ getDescriptor()

int openjaus::system::Socket::getDescriptor ( ) const

§ getInterfaces()

const std::vector< NetworkInterface *> & openjaus::system::Socket::getInterfaces ( ) const

§ getIpAddress()

const InetAddress & openjaus::system::Socket::getIpAddress ( ) const

§ getPort()

uint16_t openjaus::system::Socket::getPort ( ) const

§ getTimeout()

const Time & openjaus::system::Socket::getTimeout ( ) const

§ initialize()

void openjaus::system::Socket::initialize ( )
staticprotected

§ isBlocking()

bool openjaus::system::Socket::isBlocking ( ) const

§ isLocalAddress()

bool openjaus::system::Socket::isLocalAddress ( const InetAddress ipAddress)
Parameters
ipAddress

§ lookupInterfaces()

std::vector< NetworkInterface > openjaus::system::Socket::lookupInterfaces ( )
static

§ readInterfaces()

void openjaus::system::Socket::readInterfaces ( )

§ receive()

virtual int openjaus::system::Socket::receive ( Packet )
pure virtual

§ send()

virtual int openjaus::system::Socket::send ( Packet )
pure virtual

§ setTimeout()

bool openjaus::system::Socket::setTimeout ( const Time timeout)
Parameters
timeoutThe value of the new timeout.

§ shouldLookupBroadcastAddress()

bool openjaus::system::Socket::shouldLookupBroadcastAddress ( const NetworkInterface networkInterface)
staticprivate

§ toString()

std::string openjaus::system::Socket::toString ( ) const
virtual

Friends And Related Function Documentation

§ operator<< [1/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const Socket object 
)
friend

§ operator<< [2/2]

OPENJAUS_EXPORT friend std::ostream& operator<< ( std::ostream &  output,
const Socket object 
)
friend

Member Data Documentation

§ blocking

bool openjaus::system::Socket::blocking
protected

§ descriptor

int openjaus::system::Socket::descriptor
protected

§ descriptorCount

int openjaus::system::Socket::descriptorCount = 0
staticprotected

§ interfaces

std::vector< NetworkInterface* > openjaus::system::Socket::interfaces
protected

§ ipAddress

InetAddress openjaus::system::Socket::ipAddress
protected

§ port

uint16_t openjaus::system::Socket::port
protected

§ timeout

Time openjaus::system::Socket::timeout
protected

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