JNET::JControlHost Class Reference

ControlHost class. More...

#include <JControlHost.hh>

Inheritance diagram for JNET::JControlHost:

Public Member Functions
	JControlHost (const JHostname &server)
	Constructor.
	JControlHost (const std::string &server, const int port)
	Constructor.
	JControlHost (const int ip_number, const int port=DISPATCH_PORT)
	Constructor.
	JControlHost (const JTCPSocket &socket)
	Constructor.
	~JControlHost ()
	Destructor.
int	Subscribe (const JSubscription &subscription)
	Subscribe to single tag.
int	Subscribe (const JSubscriptionList &subscription)
	Subscribe to list of tags.
int	MyId (const std::string &nick_name)
	Identify.
int	SendMeNext ()
	Tell server to send next message.
int	SendMeAlways ()
	Tell server to send messages forever.
int	PutFullData (const JTag &tag, const void *buffer, const long long int length)
	Send data.
int	PutFullData (const std::string &tag, const void *buffer, const long long int length)
	Send data.
int	PutFullString (const JTag &tag, const std::string &buffer)
	Send string.
int	PutFullString (const std::string &tag, const std::string &buffer)
	Send string.
int	Connected ()
	Send version.
int	WaitHead (JPrefix &prefix)
	Wait for header.
int	WaitHead (std::string &tag, long long int &length)
	Wait for header.
int	CheckHead (JPrefix &prefix, JTimeval timeout=JTimeval::min())
	Check for header, without waiting.
int	CheckHead (std::string &tag, long long int &length, const int timeout_us=0)
	Check for header, without waiting.
int	GetFullData (void *buffer, long long int length)
	Receive data.
int	GetFullString (std::string &buffer)
	Receive string.
int	configure ()
	Configure socket (factory reset).
int	read (char *buffer, const int length) override
	Read data from socket.
int	write (const char *buffer, const int length) override
	Write data to socket.
void	setNonBlocking (const bool on)
	Set non-blocking of I/O.
bool	getNonBlocking () const
	Get non-blocking of I/O.
void	setKeepIdle (const int t_s)
	Set the TCP idle time.
void	setKeepCnt (const int count)
	Set the TCP idle count.
void	setKeepIntvl (const int t_s)
	Set the TCP interval time.
void	setTcpNoDelay (const bool on)
	Set TCP no-delay.
bool	getTcpNoDelay () const
	Get TCP no-delay.
void	accept (const int server)
	Accept connection from a server.
void	connect (const int port)
	Connect to port on local host.
void	connect (const JHostname &hostname)
	Connect to port on specified host.
void	connect (const std::string &hostname, const int port)
	Connect to port on specified host.
void	connect (const int ip_number, const int port)
	Connect to port on specified host.
int	shutdown ()
	Shut down socket.
void	setKeepAlive (const bool on)
	Set keep alive of socket.
bool	getKeepAlive () const
	Get keep alive of socket.
void	setReuseAddress (const bool on)
	Set reuse address.
bool	getReuseAddress () const
	Get reuse address.
void	setReceiveBufferSize (const int size)
	Set receive buffer size.
int	getReceiveBufferSize () const
	Set receive buffer size.
void	setSendBufferSize (const int size)
	Set send buffer size.
int	getSendBufferSize () const
	Get send buffer size.
int	close ()
	Close file.
bool	in_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of input.
bool	out_avail (JTimeval timeout=JTimeval::min()) const
	Check availability of output.
virtual bool	good () const
	Check status.
virtual bool	fail () const
	Check status.
virtual bool	bad () const
	Check status.
virtual bool	eof () const
	Check end of file.
bool	less (const JAbstractFile &file) const
	Less than operation.
int	getFileDescriptor () const
	Get file descriptor.
void	setFileDescriptor (const int file)
	Set file descriptor.
bool	is_open () const
	Get open status.
const sockaddr *	getSockaddr () const
	Get sockaddr.
sockaddr *	getSockaddr ()
	Get sockaddr.
int	getFamily () const
	Get family.
void	setFamily (const int family)
	Set family.
std::string	getHostname () const
	Get host name.
int	getIPnumber () const
	Get IP number.
void	setIPnumber (const int ip_number)
	Set IP number.
void	setIPnumber ()
	Set any IP number.
int	getPort () const
	Get port number.
void	setPort (const int port)
	Set port number.

Static Public Member Functions
static bool	maybe_special (const JTag &tag)
	Check special ControlHost tags.
static bool	is_valid (const char c)
	Check validity of subscription specifier.
static int	WhereIs (const std::string &host_name, const std::string &nick_name, std::string &answer)
	Locate ControlHost client(s).
static const int	getDefaultBufferSize ()
	Default socket buffer size to be used on this system.
static int	sizeOf ()
	Get size of object.
static void	Throw (const bool option)
	Enable/disable throw option.
static int	Throw (const JException_t &error, const int value=-1)
	Throw exception or return error.

Static Public Attributes
static const int	FILE_CLOSED = -1

Protected Member Functions
	JControlHost ()
	Default constructor.
template<class T >
void	setOption (const int level, const int option, const T value)
	Set socket option.
template<class T >
T	getOption (const int level, const int option) const
	Get socket option.

Protected Attributes
int	fileDescriptor

Static Protected Attributes
static bool	do_throw
	throw option

Private Member Functions
	JControlHost (const JControlHost &)
	JControlHost (JControlHost &&)
JControlHost &	operator= (const JControlHost &)
JControlHost &	operator= (JControlHost &&)

Private Attributes
JPrefix	prefix
int	result

Detailed Description

ControlHost class.

Definition at line 248 of file JControlHost.hh.

Constructor & Destructor Documentation

JControlHost() [1/7]

JNET::JControlHost::JControlHost ( )

inlineprotected

Default constructor.

Definition at line 256 of file JControlHost.hh.

    {
      configure();
    }

JControlHost() [2/7]

JNET::JControlHost::JControlHost ( const JHostname & server )

inline

Constructor.

Parameters

server

host name and optional port number

Definition at line 294 of file JControlHost.hh.

    {
      if (server.hostname != "")
        connect(server.hostname, server.port);
      else
        connect(server.port);
 
      configure();
    }

JControlHost() [3/7]

JNET::JControlHost::JControlHost ( const std::string & server, const int port )

inline

Constructor.

Parameters

server	host name
port	port

Definition at line 311 of file JControlHost.hh.

    {
      connect(server, port);
 
      configure();
    }

JControlHost() [4/7]

JNET::JControlHost::JControlHost ( const int ip_number, const int port = DISPATCH_PORT )

inline

Constructor.

Parameters

ip_number	IP number
port	port

Definition at line 326 of file JControlHost.hh.

    {
      connect(ip_number, port);
 
      configure();
    }

JControlHost() [5/7]

JNET::JControlHost::JControlHost ( const JTCPSocket & socket )

inline

Constructor.

Parameters

socket

socket

Definition at line 340 of file JControlHost.hh.

                                           :
      JSocketBlocking(socket)
    {}

~JControlHost()

JNET::JControlHost::~JControlHost ( )

inline

Destructor.

Definition at line 348 of file JControlHost.hh.

    {
      shutdown();
    }

JControlHost() [6/7]

JNET::JControlHost::JControlHost ( const JControlHost & )

private

JControlHost() [7/7]

JNET::JControlHost::JControlHost ( JControlHost && )

private

Member Function Documentation

maybe_special()

static bool JNET::JControlHost::maybe_special ( const JTag & tag )

inlinestatic

Check special ControlHost tags.

Parameters

tag

tag

Returns

true if possibly special tag; else false

Definition at line 269 of file JControlHost.hh.

    {
      return tag[0] == '_';
    }

is_valid()

static bool JNET::JControlHost::is_valid ( const char c )

inlinestatic

Check validity of subscription specifier.

Parameters

c	subscription specifier

Returns

true if valid; else false

Definition at line 281 of file JControlHost.hh.

    {
      return (c == SUBSCRIBE_ALL ||
              c == SUBSCRIBE_ANY);// ||
              //c == SUBSCRIBE_SHARED_MEMORY);
    }

Subscribe() [1/2]

int JNET::JControlHost::Subscribe ( const JSubscription & subscription )

inline

Subscribe to single tag.

Parameters

subscription

subscription

Returns

0 if OK; -1 if socket error

Definition at line 360 of file JControlHost.hh.

    {
      return PutFullString(DISPTAG_Subscribe, subscription.toString());
    } 

Subscribe() [2/2]

int JNET::JControlHost::Subscribe ( const JSubscriptionList & subscription )

inline

Subscribe to list of tags.

Parameters

subscription

subscription

Returns

0 if OK; -1 if socket error

Definition at line 372 of file JControlHost.hh.

    {
      return PutFullString(DISPTAG_Subscribe, subscription.toString());
    } 

MyId()

int JNET::JControlHost::MyId ( const std::string & nick_name )

inline

Identify.

Parameters

nick_name

nick name

Returns

0 if OK; -1 if socket error

Definition at line 384 of file JControlHost.hh.

    {
      return PutFullString(DISPTAG_MyId, nick_name);
    } 

SendMeNext()

int JNET::JControlHost::SendMeNext ( )

inline

Tell server to send next message.

Returns

0 if OK; -1 if socket error

Definition at line 395 of file JControlHost.hh.

    {
      return PutFullData(DISPTAG_Gime, NULL, 0);
    } 

SendMeAlways()

int JNET::JControlHost::SendMeAlways ( )

inline

Tell server to send messages forever.

Returns

0 if OK; -1 if socket error

Definition at line 406 of file JControlHost.hh.

    {
      return PutFullData(DISPTAG_Always, NULL, 0);
    } 

PutFullData() [1/2]

int JNET::JControlHost::PutFullData ( const JTag & tag, const void * buffer, const long long int length )

inline

Send data.

Parameters

tag	tag
buffer	data
length	number of bytes

Returns

0 if OK; -1 if socket error; -2 if other error

Definition at line 420 of file JControlHost.hh.

    {
      try {
 
        JPrefix __prefix__(tag, length);
 
        write((char*) &__prefix__, sizeof(JPrefix));
 
        if (length != 0) {
          write((char*) buffer, (int) length);
        }
 
        return 0;
      }
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
    }

PutFullData() [2/2]

int JNET::JControlHost::PutFullData ( const std::string & tag, const void * buffer, const long long int length )

inline

Send data.

Parameters

tag	tag
buffer	data
length	number of bytes

Returns

0 if OK; -1 if socket error; -2 if other error

Definition at line 448 of file JControlHost.hh.

    {
      try {
        return PutFullData(JTag(tag), buffer, length);
      }
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
      catch (const JControlHostException& error) {
        return Throw(error, -2);
      }
    }

PutFullString() [1/2]

int JNET::JControlHost::PutFullString ( const JTag & tag, const std::string & buffer )

inline

Send string.

Parameters

tag	tag
buffer	data

Returns

0 if OK; -1 if socket error; -2 if other error

Definition at line 469 of file JControlHost.hh.

    {
      return PutFullData(tag, buffer.c_str(), buffer.size());
    }

PutFullString() [2/2]

int JNET::JControlHost::PutFullString ( const std::string & tag, const std::string & buffer )

inline

Send string.

Parameters

tag	tag
buffer	data

Returns

0 if OK; -1 if socket error; -2 if other error

Definition at line 483 of file JControlHost.hh.

    {
      return PutFullData(tag, buffer.c_str(), buffer.size());
    }

Connected()

int JNET::JControlHost::Connected ( )

inline

Send version.

Returns

0 if OK; -1 if socket error; -2 if other error

Definition at line 495 of file JControlHost.hh.

    {
      return PutFullString(DISPTAG_Version, CHOO_VERSION);
    }

WaitHead() [1/2]

int JNET::JControlHost::WaitHead ( JPrefix & prefix )

inline

Wait for header.

Parameters

prefix

prefix

Returns

0 if OK; -1 if socket error

Definition at line 507 of file JControlHost.hh.

    {
      try {
 
        read((char*) &this->prefix, sizeof(JPrefix));
        
        prefix = this->prefix;
 
        return 0;
      }
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
    }

WaitHead() [2/2]

int JNET::JControlHost::WaitHead ( std::string & tag, long long int & length )

inline

Wait for header.

Parameters

tag	tag
length	number of bytes

Returns

0 if OK; -1 if socket error

Definition at line 530 of file JControlHost.hh.

    {
      const int rvalue = WaitHead(this->prefix);
 
      if (rvalue == 0) {
        tag    = this->prefix.getTag();
        length = this->prefix.getSize();
      }
 
      return rvalue;
    }

CheckHead() [1/2]

int JNET::JControlHost::CheckHead ( JPrefix & prefix, JTimeval timeout = JTimeval::min() )

inline

Check for header, without waiting.

Parameters

prefix	prefix
timeout	timeout

Returns

1 if header; 0 if no header; -1 if socket error

Definition at line 550 of file JControlHost.hh.

    {
      try {
 
        if (in_avail(timeout)) {
 
          WaitHead(prefix);
 
          return 1;
 
        } else {
 
          return 0;
        }
      }
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
    }

CheckHead() [2/2]

int JNET::JControlHost::CheckHead ( std::string & tag, long long int & length, const int timeout_us = 0 )

inline

Check for header, without waiting.

Parameters

tag	tag
length	number of bytes
timeout_us	timeout [us]

Returns

1 if header; 0 if no header; -1 if socket error

Definition at line 579 of file JControlHost.hh.

    {
      const int rvalue = CheckHead(this->prefix, timeout_us);
 
      if (rvalue == 1) {
        tag    = this->prefix.getTag();
        length = this->prefix.getSize();
      }
 
      return rvalue;
    }

GetFullData()

int JNET::JControlHost::GetFullData ( void * buffer, long long int length )

inline

Receive data.

Parameters

buffer	data
length	number of bytes

Returns

0 if OK; -1 if socket error

Definition at line 599 of file JControlHost.hh.

    {
      try {
 
        read((char*) buffer, (int) length);
 
        return 0;
      } 
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
    }

GetFullString()

int JNET::JControlHost::GetFullString ( std::string & buffer )

inline

Receive string.

Parameters

buffer

data

Returns

0 if OK; -1 if socket error

Definition at line 619 of file JControlHost.hh.

    {
      buffer.resize(this->prefix.getSize());
      
      return GetFullData((char*) buffer.data(), buffer.size());
    }

WhereIs()

static int JNET::JControlHost::WhereIs ( const std::string & host_name, const std::string & nick_name, std::string & answer )

inlinestatic

Locate ControlHost client(s).

Parameters

host_name	host name
nick_name	nick name
answer	list of host names

Returns

0 if OK; -1 if socket error

Definition at line 635 of file JControlHost.hh.

    {
      try {
 
        using namespace std;
 
        JControlHost socket(host_name);
        
        socket.PutFullString(DISPTAG_WhereIs, nick_name);
        
        string        tag;
        long long int length;
        
        socket.WaitHead(tag, length);
        socket.GetFullString(answer);
 
        return 0;
      }
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
    } 

configure()

int JNET::JControlHost::configure ( )

inline

Configure socket (factory reset).

Returns

0 if OK; -1 if socket error

Definition at line 666 of file JControlHost.hh.

    {
      try {
 
        setTcpNoDelay  (true);
        setReuseAddress(true);
        setKeepAlive   (true);
        setSendBufferSize   (128*1024);
        setReceiveBufferSize(128*1024);
        setNonBlocking (false);
 
        return 0;
      }
      catch (const JSocketException& error) {
        return Throw(error, -1);
      }
    } 

operator=() [1/2]

JControlHost & JNET::JControlHost::operator= ( const JControlHost & )

private

operator=() [2/2]

JControlHost & JNET::JControlHost::operator= ( JControlHost && )

private

read()

int JNET::JSocketBlocking::read ( char * buffer, const int length )

inlineoverridevirtualinherited

Read data from socket.

Parameters

buffer	buffer
length	number of bytes to read

Returns

number of bytes read

Reimplemented from JNET::JSocket.

Definition at line 52 of file JSocketBlocking.hh.

    {
      char* data = buffer;
      int   size = length;
                  
      while (size != 0) { 
        
        const int pos = JSocket::read(data, size);
        
        if (pos != 0) {
          data += pos;
          size -= pos;
        } else {
          in_avail(1);
        }
      }
 
      return length - size;
    }

write()

int JNET::JSocketBlocking::write ( const char * buffer, const int length )

inlineoverridevirtualinherited

Write data to socket.

Parameters

buffer	buffer
length	number of bytes to write

Returns

number of bytes written

Reimplemented from JNET::JSocket.

Definition at line 80 of file JSocketBlocking.hh.

    {
      const char* data = buffer;
      int         size = length;
                  
      while (size != 0) { 
        
        const int pos = JSocket::write(data, size);
        
        if (pos != 0) {
          data += pos;
          size -= pos;
        } else {
          out_avail(1);
        }
      }
 
      return length - size;
    }

setNonBlocking()

void JNET::JTCPSocket::setNonBlocking ( const bool on )

inlineinherited

Set non-blocking of I/O.

Parameters

on	true to enable non-blocking; false to disable

Definition at line 56 of file JTCPSocket.hh.

    {
      const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
      const int mask  = FNDELAY;
 
      if (flags == -1) {
        THROW(JSocketException, "Get socket option failed " << errno);
      }
 
      if (((flags & mask) != mask &&  on) ||
          ((flags & mask) != 0    && !on) ) {
 
        if (fcntl(getFileDescriptor(), F_SETFL, flags ^ mask) < 0) {
          THROW(JSocketException, "Set socket option failed " << errno);
        }
      }
    }

getNonBlocking()

bool JNET::JTCPSocket::getNonBlocking ( ) const

inlineinherited

Get non-blocking of I/O.

Returns

true if enabled non-blocking; else false

Definition at line 80 of file JTCPSocket.hh.

    {
      const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
      const int mask  = FNDELAY;
 
      if (flags == -1) {
        THROW(JSocketException, "Get socket option failed " << errno);
      }
 
      return ((flags & mask) != 0);
    }

setKeepIdle()

void JNET::JTCPSocket::setKeepIdle ( const int t_s )

inlineinherited

Set the TCP idle time.

Parameters

t_s

time [s]

Definition at line 98 of file JTCPSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPIDLE, t_s);
    }

setKeepCnt()

void JNET::JTCPSocket::setKeepCnt ( const int count )

inlineinherited

Set the TCP idle count.

Parameters

count

count

Definition at line 109 of file JTCPSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPCNT, count);
    }

setKeepIntvl()

void JNET::JTCPSocket::setKeepIntvl ( const int t_s )

inlineinherited

Set the TCP interval time.

Parameters

t_s

time [s]

Definition at line 120 of file JTCPSocket.hh.

    {
      setOption(IPROTO_TCP, TCP_KEEPINTVL, t_s);
    }

setTcpNoDelay()

void JNET::JTCPSocket::setTcpNoDelay ( const bool on )

inlineinherited

Set TCP no-delay.

Parameters

on	true to set TCP no-delay; false to disable

Definition at line 131 of file JTCPSocket.hh.

    {
      setOption(IPPROTO_TCP, TCP_NODELAY, int(on ? 1 : 0));
    }

getTcpNoDelay()

bool JNET::JTCPSocket::getTcpNoDelay ( ) const

inlineinherited

Get TCP no-delay.

Returns

true if TCP no-delay; else false

Definition at line 142 of file JTCPSocket.hh.

    {
      return (getOption<int>(IPPROTO_TCP, TCP_NODELAY) == 1);
    }

accept()

void JNET::JTCPSocket::accept ( const int server )

inlineinherited

Accept connection from a server.

Parameters

server

file descriptor of TCP server socket

Definition at line 153 of file JTCPSocket.hh.

    {
      socklen_t size = sizeof(sockaddr_in);
 
      fileDescriptor = ::accept(server, getSockaddr(), &size);
    }

connect() [1/4]

void JNET::JTCPSocket::connect ( const int port )

inlineinherited

Connect to port on local host.

Parameters

port	port number

Definition at line 166 of file JTCPSocket.hh.

    {
      connect(INADDR_ANY, port);
    }

connect() [2/4]

void JNET::JTCPSocket::connect ( const JHostname & hostname )

inlineinherited

Connect to port on specified host.

Parameters

hostname

host name

Definition at line 177 of file JTCPSocket.hh.

    {
      connect(hostname.hostname, hostname.port);
    }

connect() [3/4]

void JNET::JTCPSocket::connect ( const std::string & hostname, const int port )

inlineinherited

Connect to port on specified host.

Parameters

hostname	host name
port	port number

Definition at line 189 of file JTCPSocket.hh.

    {
      connect(JSYSTEM::getIPnumber(hostname), port);
    }

connect() [4/4]

void JNET::JTCPSocket::connect ( const int ip_number, const int port )

inlineinherited

Connect to port on specified host.

Parameters

ip_number	IP number
port	port number

Definition at line 201 of file JTCPSocket.hh.

    {
      setIPnumber(ip_number);
      setPort(port);
 
      if (::connect(getFileDescriptor(), getSockaddr(), sizeof(sockaddr_in)) < 0) {
        THROW(JSocketException, "Socket connection failed " << JSYSTEM::getIPaddress(ip_number) << ":" << port << " / " << getFileDescriptor() << " " << errno);
      }
    }

getDefaultBufferSize()

static const int JNET::JSocket::getDefaultBufferSize ( )

inlinestaticinherited

Default socket buffer size to be used on this system.

Returns

number of bytes

Definition at line 75 of file JSocket.hh.

    {
#if __APPLE__
         return JMATH::MEGABYTE;
#else
         return JMATH::GIGABYTE;
#endif
    }

shutdown()

int JNET::JSocket::shutdown ( )

inlineinherited

Shut down socket.

Returns

return value

Definition at line 89 of file JSocket.hh.

    {
      const int value = ::shutdown(getFileDescriptor(), SHUT_RDWR);
 
      close();
 
      return value;
    }

setKeepAlive()

void JNET::JSocket::setKeepAlive ( const bool on )

inlineinherited

Set keep alive of socket.

Parameters

on	true to enable keep alive; false to disable

Definition at line 104 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_KEEPALIVE, int(on ? 1 : 0));
    }

getKeepAlive()

bool JNET::JSocket::getKeepAlive ( ) const

inlineinherited

Get keep alive of socket.

Returns

true if keep alive; else false

Definition at line 115 of file JSocket.hh.

    {
      return (getOption<int>(SOL_SOCKET, SO_KEEPALIVE) == 1);
    }

setReuseAddress()

void JNET::JSocket::setReuseAddress ( const bool on )

inlineinherited

Set reuse address.

Parameters

on	true to enable reuse address; false to disable

Definition at line 126 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_REUSEADDR, int(on ? 1 : 0));
    }

getReuseAddress()

bool JNET::JSocket::getReuseAddress ( ) const

inlineinherited

Get reuse address.

Returns

true if enable reuse address; else false

Definition at line 137 of file JSocket.hh.

    {
      return (getOption<int>(SOL_SOCKET, SO_REUSEADDR) == 1);
    }

setReceiveBufferSize()

void JNET::JSocket::setReceiveBufferSize ( const int size )

inlineinherited

Set receive buffer size.

Parameters

size	number of bytes

Definition at line 148 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_RCVBUF, int(size));
    }

getReceiveBufferSize()

int JNET::JSocket::getReceiveBufferSize ( ) const

inlineinherited

Set receive buffer size.

Returns

number of bytes

Definition at line 159 of file JSocket.hh.

    {
      return getOption<int>(SOL_SOCKET, SO_RCVBUF);
    }

setSendBufferSize()

void JNET::JSocket::setSendBufferSize ( const int size )

inlineinherited

Set send buffer size.

Parameters

size	number of bytes

Definition at line 170 of file JSocket.hh.

    {
      setOption(SOL_SOCKET, SO_SNDBUF, int(size));
    }

getSendBufferSize()

int JNET::JSocket::getSendBufferSize ( ) const

inlineinherited

Get send buffer size.

Returns

number of bytes

Definition at line 181 of file JSocket.hh.

    {
      return getOption<int>(SOL_SOCKET, SO_SNDBUF);
    }

setOption()

template<class T >

void JNET::JSocket::setOption ( const int level, const int option, const T value )

inlineprotectedinherited

Set socket option.

Parameters

level	level
option	option
value	value

Definition at line 274 of file JSocket.hh.

    {
      socklen_t size = sizeof(T);
 
      if (setsockopt(getFileDescriptor(), level, option, &value, size) < 0) {
        THROW(JSocketException, "Set socket option failed " << errno);
      }
    }

getOption()

template<class T >

T JNET::JSocket::getOption ( const int level, const int option ) const

inlineprotectedinherited

Get socket option.

Parameters

level	level
option	option

Returns

value

Definition at line 292 of file JSocket.hh.

    {
      T         value;
      socklen_t size  = sizeof(T);
 
      if (getsockopt(getFileDescriptor(), level, option, &value, &size) < 0) {
        THROW(JSocketException, "Get socket option failed " << errno);
      }
 
      return value;
    }

close()

int JLANG::JFile::close ( )

inlineinherited

Close file.

Returns

return value

Definition at line 57 of file JFile.hh.

    {
      int value = -1;
 
      if (fileDescriptor != FILE_CLOSED) {
 
        value = ::close(fileDescriptor);
 
        fileDescriptor = FILE_CLOSED;
        result         = 0;
      }
 
      return value;
    }

in_avail()

bool JLANG::JFile::in_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of input.

This method returns true if at least one byte can be read without blocking.

Parameters

timeout

timeout

Returns

true if ready to read; else false

Definition at line 106 of file JFile.hh.

    {
      return JFileDescriptorMask(*this).in_avail(timeout);
    }

out_avail()

bool JLANG::JFile::out_avail ( JTimeval timeout = JTimeval::min() ) const

inlineinherited

Check availability of output.

This method returns true if at least one byte can be written without blocking.

Parameters

timeout

timeout

Returns

true if ready to write; else false

Definition at line 119 of file JFile.hh.

    {
      return JFileDescriptorMask(*this).out_avail(timeout);
    }

good()

virtual bool JLANG::JFile::good ( ) const

inlinevirtualinherited

Check status.

Returns

true if last I/O operation successful; else false

Definition at line 130 of file JFile.hh.

    {
      return is_open() && !eof() && !bad();
    }

fail()

virtual bool JLANG::JFile::fail ( ) const

inlinevirtualinherited

Check status.

Returns

true if last I/O operation caused logical error; else false

Definition at line 141 of file JFile.hh.

    {
      return result == 0;
    }

bad()

virtual bool JLANG::JFile::bad ( ) const

inlinevirtualinherited

Check status.

Returns

true if last I/O operation caused read/write error; else false

Definition at line 152 of file JFile.hh.

    {
      return fail();
    }

eof()

virtual bool JLANG::JFile::eof ( ) const

inlinevirtualinherited

Check end of file.

Returns

true if end of file; else false

Definition at line 163 of file JFile.hh.

    {
      return result == EOF;
    }

less()

bool JLANG::JAbstractFile::less ( const JAbstractFile & file ) const

inlineinherited

Less than operation.

Parameters

file	JAbstractFile to be compared

Returns

true if this file descriptor is less; else false

Definition at line 64 of file JAbstractFile.hh.

    {
      return getFileDescriptor() < file.getFileDescriptor();
    }

getFileDescriptor()

int JLANG::JAbstractFile::getFileDescriptor ( ) const

inlineinherited

Get file descriptor.

Returns

file descriptor

Definition at line 75 of file JAbstractFile.hh.

    {
      return fileDescriptor;
    }

setFileDescriptor()

void JLANG::JAbstractFile::setFileDescriptor ( const int file )

inlineinherited

Set file descriptor.

Parameters

file	file descriptor

Definition at line 86 of file JAbstractFile.hh.

    {
      fileDescriptor = file;
    }

is_open()

bool JLANG::JAbstractFile::is_open ( ) const

inlineinherited

Get open status.

Definition at line 95 of file JAbstractFile.hh.

    {
      return fileDescriptor != FILE_CLOSED;
    }

getSockaddr() [1/2]

const sockaddr * JNET::JSocketAddress::getSockaddr ( ) const

inlineinherited

Get sockaddr.

Returns

pointer to sockaddr structure

Definition at line 44 of file JSocketAddress.hh.

    {
      return (const sockaddr*) static_cast<const sockaddr_in*>(this);
    }

getSockaddr() [2/2]

sockaddr * JNET::JSocketAddress::getSockaddr ( )

inlineinherited

Get sockaddr.

Returns

pointer to sockaddr structure

Definition at line 55 of file JSocketAddress.hh.

    {
      return (sockaddr*) static_cast<sockaddr_in*>(this);
    }

getFamily()

int JNET::JSocketAddress::getFamily ( ) const

inlineinherited

Get family.

Returns

family

Definition at line 66 of file JSocketAddress.hh.

    {
      return sin_family;
    }

setFamily()

void JNET::JSocketAddress::setFamily ( const int family )

inlineinherited

Set family.

Parameters

family

family

Definition at line 77 of file JSocketAddress.hh.

    {
      sin_family = family;
    }

getHostname()

std::string JNET::JSocketAddress::getHostname ( ) const

inlineinherited

Get host name.

Returns

host name

Definition at line 88 of file JSocketAddress.hh.

    {
      return JSYSTEM::getHostname(this->getIPnumber());
    }

getIPnumber()

int JNET::JSocketAddress::getIPnumber ( ) const

inlineinherited

Get IP number.

Returns

IP number

Definition at line 99 of file JSocketAddress.hh.

    {
      return sin_addr.s_addr;
    }

setIPnumber() [1/2]

void JNET::JSocketAddress::setIPnumber ( const int ip_number )

inlineinherited

Set IP number.

Parameters

ip_number

IP number

Definition at line 110 of file JSocketAddress.hh.

    {
      sin_addr.s_addr = ip_number;
    }

setIPnumber() [2/2]

void JNET::JSocketAddress::setIPnumber ( )

inlineinherited

Set any IP number.

Definition at line 119 of file JSocketAddress.hh.

    {
      sin_addr.s_addr = htonl(INADDR_ANY);
    }

getPort()

int JNET::JSocketAddress::getPort ( ) const

inlineinherited

Get port number.

Returns

port number

Definition at line 130 of file JSocketAddress.hh.

    {
      return ntohs(this->sin_port);
    }

setPort()

void JNET::JSocketAddress::setPort ( const int port )

inlineinherited

Set port number.

Parameters

port	port number

Definition at line 141 of file JSocketAddress.hh.

    {
      if (port >= 0 && port <= std::numeric_limits<u_short>::max())
        sin_port = htons((u_short) port);
      else
        THROW(JCastException, "JSocketAddress::setPort() illegal value.");
    }

sizeOf()

static int JNET::JSocketAddress::sizeOf ( )

inlinestaticinherited

Get size of object.

Returns

number of bytes

Definition at line 155 of file JSocketAddress.hh.

    {
      return sizeof(sockaddr_in);
    }

Throw() [1/2]

static void JLANG::JThrow< JControlHost >::Throw ( const bool option )

inlinestaticinherited

Enable/disable throw option.

Parameters

option

true enable; false disable

Definition at line 37 of file JThrow.hh.

    {
      do_throw = option;
    }

Throw() [2/2]

static int JLANG::JThrow< JControlHost >::Throw ( const JException_t & error, const int value = -1 )

inlinestaticinherited

Throw exception or return error.

Parameters

error	exception
value	return code

Returns

return code

Definition at line 51 of file JThrow.hh.

    {
      using namespace std;
      
      if (do_throw) {
        throw error;
      }
 
      cerr << error.what() << endl;
      
      return value;
    }

Member Data Documentation

prefix

JPrefix JNET::JControlHost::prefix

mutableprivate

Definition at line 686 of file JControlHost.hh.

result

int JLANG::JFile::result

privateinherited

Definition at line 170 of file JFile.hh.

FILE_CLOSED

const int JLANG::JAbstractFile::FILE_CLOSED = -1

staticinherited

Definition at line 27 of file JAbstractFile.hh.

fileDescriptor

int JLANG::JAbstractFile::fileDescriptor

protectedinherited

Definition at line 102 of file JAbstractFile.hh.

do_throw

bool JLANG::JThrow< JControlHost >::do_throw

staticprotectedinherited

throw option

Set default throw option to true.

Definition at line 28 of file JThrow.hh.

---

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

• JControlHost.hh