Jpp  19.1.0
the software that should make you happy
Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Private Attributes | List of all members
JNET::JLigierObjectIterator< T > Class Template Reference

Object iteration through ControlHost server. More...

#include <JLigierObjectIterator.hh>

Inheritance diagram for JNET::JLigierObjectIterator< T >:
JNET::JServerSocket JLANG::JAbstractObjectIterator< T > std::vector< JSocketInputChannel_t > JNET::JTCPSocket JLANG::JObjectIterator< T > JNET::JSocket JLANG::JFile JNET::JSocketAddress JLANG::JAbstractFile JLANG::JBinaryInput JLANG::JBinaryOutput JLANG::JComparable< JAbstractFile >

Public Types

typedef JObjectIterator< T >::pointer_type pointer_type
 

Public Member Functions

 JLigierObjectIterator (const int port, const int backlog, const int buffer_size=262144, const int timeout_us=10)
 Constructor. More...
 
virtual bool setObject (T &object) override
 Set object. More...
 
void setNonBlocking (const bool on)
 Set non-blocking of I/O. More...
 
bool getNonBlocking () const
 Get non-blocking of I/O. More...
 
void setKeepIdle (const int t_s)
 Set the TCP idle time. More...
 
void setKeepCnt (const int count)
 Set the TCP idle count. More...
 
void setKeepIntvl (const int t_s)
 Set the TCP interval time. More...
 
void setTcpNoDelay (const bool on)
 Set TCP no-delay. More...
 
bool getTcpNoDelay () const
 Get TCP no-delay. More...
 
void accept (const int server)
 Accept connection from a server. More...
 
void connect (const int port)
 Connect to port on local host. More...
 
void connect (const JHostname &hostname)
 Connect to port on specified host. More...
 
void connect (const std::string &hostname, const int port)
 Connect to port on specified host. More...
 
void connect (const int ip_number, const int port)
 Connect to port on specified host. More...
 
int shutdown ()
 Shut down socket. More...
 
void setKeepAlive (const bool on)
 Set keep alive of socket. More...
 
bool getKeepAlive () const
 Get keep alive of socket. More...
 
void setReuseAddress (const bool on)
 Set reuse address. More...
 
bool getReuseAddress () const
 Get reuse address. More...
 
void setReceiveBufferSize (const int size)
 Set receive buffer size. More...
 
int getReceiveBufferSize () const
 Set receive buffer size. More...
 
void setSendBufferSize (const int size)
 Set send buffer size. More...
 
int getSendBufferSize () const
 Get send buffer size. More...
 
virtual int read (char *buffer, const int length) override
 Read data from socket. More...
 
virtual int write (const char *buffer, const int length) override
 Write data to socket. More...
 
int close ()
 Close file. More...
 
bool in_avail (JTimeval timeout=JTimeval::min()) const
 Check availability of input. More...
 
bool out_avail (JTimeval timeout=JTimeval::min()) const
 Check availability of output. More...
 
virtual bool good () const
 Check status. More...
 
virtual bool fail () const
 Check status. More...
 
virtual bool bad () const
 Check status. More...
 
virtual bool eof () const
 Check end of file. More...
 
bool less (const JAbstractFile &file) const
 Less than operation. More...
 
int getFileDescriptor () const
 Get file descriptor. More...
 
void setFileDescriptor (const int file)
 Set file descriptor. More...
 
bool is_open () const
 Get open status. More...
 
const sockaddr * getSockaddr () const
 Get sockaddr. More...
 
sockaddr * getSockaddr ()
 Get sockaddr. More...
 
int getFamily () const
 Get family. More...
 
void setFamily (const int family)
 Set family. More...
 
std::string getHostname () const
 Get host name. More...
 
int getIPnumber () const
 Get IP number. More...
 
void setIPnumber (const int ip_number)
 Set IP number. More...
 
void setIPnumber ()
 Set any IP number. More...
 
int getPort () const
 Get port number. More...
 
void setPort (const int port)
 Set port number. More...
 
virtual bool hasNext () override
 Check availability of next element. More...
 
virtual const pointer_typenext () override
 Get next element. More...
 
virtual skip_type skip (const skip_type ns)
 Skip items. More...
 

Static Public Member Functions

static const int getDefaultBufferSize ()
 Default socket buffer size to be used on this system. More...
 
static int sizeOf ()
 Get size of object. More...
 

Static Public Attributes

static const int FILE_CLOSED = -1
 

Protected Member Functions

template<class T >
void setOption (const int level, const int option, const T value)
 Set socket option. More...
 
template<class T >
getOption (const int level, const int option) const
 Get socket option. More...
 

Protected Attributes

int fileDescriptor
 
object
 object More...
 
bool has_next
 status More...
 

Private Attributes

JSelectReader select
 
int buffer_size
 
int timeout_us
 
int result
 
pointer_type ps
 

Detailed Description

template<class T>
class JNET::JLigierObjectIterator< T >

Object iteration through ControlHost server.

This class implements the JLANG::JObjectIterator interface.

Definition at line 46 of file JLigierObjectIterator.hh.

Member Typedef Documentation

◆ pointer_type

template<class T >
typedef JObjectIterator<T>::pointer_type JLANG::JAbstractObjectIterator< T >::pointer_type
inherited

Definition at line 39 of file JAbstractObjectIterator.hh.

Constructor & Destructor Documentation

◆ JLigierObjectIterator()

template<class T >
JNET::JLigierObjectIterator< T >::JLigierObjectIterator ( const int  port,
const int  backlog,
const int  buffer_size = 262144,
const int  timeout_us = 10 
)
inline

Constructor.

Parameters
portserver port
backlogserver backlog
buffer_sizesocket buffer size
timeout_ustimeout [us]

Definition at line 61 of file JLigierObjectIterator.hh.

64  :
65  JServerSocket(port,backlog),
68  {}
JServerSocket(const int port, const int backlog)
Constructor.

Member Function Documentation

◆ setObject()

template<class T >
virtual bool JNET::JLigierObjectIterator< T >::setObject ( T &  object)
inlineoverridevirtual

Set object.

Parameters
objectreference to object to be set
Returns
true if set; else false

Implements JLANG::JAbstractObjectIterator< T >.

Definition at line 77 of file JLigierObjectIterator.hh.

78  {
79  using namespace std;
80 
81  for ( ; ; ) {
82 
83  select.reset();
85 
86  for (const_iterator channel = this->begin(); channel != this->end(); ++channel) {
87  if (!channel->isReady()) {
88  select.setReaderMask(channel->getFileDescriptor());
89  }
90  }
91 
92  if (select(timeout_us) > 0) {
93 
94  for (iterator channel = this->begin(); channel != this->end(); ) {
95 
96  if (select.hasReaderMask(*channel)) {
97 
98  try {
99 
100  channel->read();
101 
102  if (channel->isReady()) {
103 
104  if (channel->prefix.getTag() == getTag<T>()) {
105 
106  channel->seekg(sizeof(JPrefix));
107 
108  *channel >> object; // read object
109 
110  channel->reset();
111 
112  return true;
113 
114  } else {
115 
116  channel->reset(); // skip data
117  }
118  }
119  }
120  catch(const exception& error) {
121 
122  channel->shutdown();
123 
124  channel = this->erase(channel);
125 
126  continue;
127  }
128  }
129 
130  ++channel;
131  }
132 
133  if (select.hasReaderMask(*this)) {
134 
135  JTCPSocket socket(this->getFileDescriptor());
136 
137  //socket.setSendBufferSize (buffer_size);
138  socket.setReceiveBufferSize(buffer_size);
139 
140  socket.setKeepAlive (true);
141  socket.setNonBlocking(true);
142 
143  this->push_back(JSocketInputChannel_t(socket));
144  }
145  }
146  }
147 
148  return false;
149  }
int getFileDescriptor() const
Get file descriptor.
ControlHost prefix.
Definition: JPrefix.hh:33
void setReaderMask(const JAbstractFile &file)
Set reader mask.
void reset()
Reset.
bool hasReaderMask(const JAbstractFile &file) const
Has reader file.
TCP socket.
Definition: JTCPSocket.hh:30
JSocketInputChannel< JPrefix_t > JSocketInputChannel_t
Definition: JLigier.cc:30
Definition: JSTDTypes.hh:14

◆ setNonBlocking()

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

Set non-blocking of I/O.

Parameters
ontrue to enable non-blocking; false to disable

Definition at line 56 of file JTCPSocket.hh.

57  {
58  const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
59  const int mask = FNDELAY;
60 
61  if (flags == -1) {
62  THROW(JSocketException, "Get socket option failed " << errno);
63  }
64 
65  if (((flags & mask) != mask && on) ||
66  ((flags & mask) != 0 && !on) ) {
67 
68  if (fcntl(getFileDescriptor(), F_SETFL, flags ^ mask) < 0) {
69  THROW(JSocketException, "Set socket option failed " << errno);
70  }
71  }
72  }
#define THROW(JException_t, A)
Marco for throwing exception with std::ostream compatible message.
Definition: JException.hh:712
Exception for socket.
Definition: JException.hh:468

◆ 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.

81  {
82  const int flags = fcntl(getFileDescriptor(), F_GETFL, -1);
83  const int mask = FNDELAY;
84 
85  if (flags == -1) {
86  THROW(JSocketException, "Get socket option failed " << errno);
87  }
88 
89  return ((flags & mask) != 0);
90  }

◆ setKeepIdle()

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

Set the TCP idle time.

Parameters
t_stime [s]

Definition at line 98 of file JTCPSocket.hh.

99  {
100  setOption(IPROTO_TCP, TCP_KEEPIDLE, t_s);
101  }
#define IPROTO_TCP
Definition: JTCPSocket.hh:11
void setOption(const int level, const int option, const T value)
Set socket option.
Definition: JSocket.hh:274

◆ setKeepCnt()

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

Set the TCP idle count.

Parameters
countcount

Definition at line 109 of file JTCPSocket.hh.

110  {
111  setOption(IPROTO_TCP, TCP_KEEPCNT, count);
112  }

◆ setKeepIntvl()

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

Set the TCP interval time.

Parameters
t_stime [s]

Definition at line 120 of file JTCPSocket.hh.

121  {
122  setOption(IPROTO_TCP, TCP_KEEPINTVL, t_s);
123  }

◆ setTcpNoDelay()

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

Set TCP no-delay.

Parameters
ontrue to set TCP no-delay; false to disable

Definition at line 131 of file JTCPSocket.hh.

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

◆ 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.

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

◆ accept()

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

Accept connection from a server.

Parameters
serverfile descriptor of TCP server socket

Definition at line 153 of file JTCPSocket.hh.

154  {
155  socklen_t size = sizeof(sockaddr_in);
156 
157  fileDescriptor = ::accept(server, getSockaddr(), &size);
158  }
const sockaddr * getSockaddr() const
Get sockaddr.
void accept(const int server)
Accept connection from a server.
Definition: JTCPSocket.hh:153

◆ connect() [1/4]

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

Connect to port on local host.

Parameters
portport number

Definition at line 166 of file JTCPSocket.hh.

167  {
168  connect(INADDR_ANY, port);
169  }
void connect(const int port)
Connect to port on local host.
Definition: JTCPSocket.hh:166

◆ connect() [2/4]

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

Connect to port on specified host.

Parameters
hostnamehost name

Definition at line 177 of file JTCPSocket.hh.

178  {
179  connect(hostname.hostname, hostname.port);
180  }
std::string hostname
Definition: JHostname.hh:171

◆ connect() [3/4]

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

Connect to port on specified host.

Parameters
hostnamehost name
portport number

Definition at line 189 of file JTCPSocket.hh.

190  {
191  connect(JSYSTEM::getIPnumber(hostname), port);
192  }
int getIPnumber(const std::string &host_name)
Get IP number.
Definition: JNetwork.hh:117

◆ connect() [4/4]

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

Connect to port on specified host.

Parameters
ip_numberIP number
portport number

Definition at line 201 of file JTCPSocket.hh.

202  {
203  setIPnumber(ip_number);
204  setPort(port);
205 
206  if (::connect(getFileDescriptor(), getSockaddr(), sizeof(sockaddr_in)) < 0) {
207  THROW(JSocketException, "Socket connection failed " << JSYSTEM::getIPaddress(ip_number) << ":" << port << " / " << getFileDescriptor() << " " << errno);
208  }
209  }
void setIPnumber()
Set any IP number.
void setPort(const int port)
Set port number.
std::string getIPaddress(const int ip)
Get IP address (decimal-dot notation).
Definition: JNetwork.hh:154

◆ 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.

76  {
77 #if __APPLE__
78  return JMATH::MEGABYTE;
79 #else
80  return JMATH::GIGABYTE;
81 #endif
82  }
static const long long int GIGABYTE
Number of bytes in a mega-byte.
static const long long int MEGABYTE
Number of bytes in a kilo-byte.

◆ shutdown()

int JNET::JSocket::shutdown ( )
inlineinherited

Shut down socket.

Returns
return value

Definition at line 89 of file JSocket.hh.

90  {
91  const int value = ::shutdown(getFileDescriptor(), SHUT_RDWR);
92 
93  close();
94 
95  return value;
96  }
int close()
Close file.
Definition: JFile.hh:57
int shutdown()
Shut down socket.
Definition: JSocket.hh:89

◆ setKeepAlive()

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

Set keep alive of socket.

Parameters
ontrue to enable keep alive; false to disable

Definition at line 104 of file JSocket.hh.

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

◆ 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.

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

◆ setReuseAddress()

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

Set reuse address.

Parameters
ontrue to enable reuse address; false to disable

Definition at line 126 of file JSocket.hh.

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

◆ 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.

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

◆ setReceiveBufferSize()

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

Set receive buffer size.

Parameters
sizenumber of bytes

Definition at line 148 of file JSocket.hh.

149  {
150  setOption(SOL_SOCKET, SO_RCVBUF, int(size));
151  }

◆ getReceiveBufferSize()

int JNET::JSocket::getReceiveBufferSize ( ) const
inlineinherited

Set receive buffer size.

Returns
number of bytes

Definition at line 159 of file JSocket.hh.

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

◆ setSendBufferSize()

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

Set send buffer size.

Parameters
sizenumber of bytes

Definition at line 170 of file JSocket.hh.

171  {
172  setOption(SOL_SOCKET, SO_SNDBUF, int(size));
173  }

◆ getSendBufferSize()

int JNET::JSocket::getSendBufferSize ( ) const
inlineinherited

Get send buffer size.

Returns
number of bytes

Definition at line 181 of file JSocket.hh.

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

◆ read()

virtual int JNET::JSocket::read ( char *  buffer,
const int  length 
)
inlineoverridevirtualinherited

Read data from socket.

This method handles I/O errors in such a way that:

  1. the return value is set to zero if no data are read;
  2. an exception is thrown in case of a fatal error;
Parameters
bufferbuffer
lengthnumber of bytes to read
Returns
number of bytes actually read

Reimplemented from JLANG::JFile.

Reimplemented in JNET::JUDPSocket, and JNET::JSocketBlocking.

Definition at line 198 of file JSocket.hh.

199  {
200  int pos = JFile::read(buffer, length);
201 
202  if (pos == 0) {
203 
204  THROW(JSocketException, "Socket read failed " << getFileDescriptor() << ' ' << errno);
205 
206  } else if (pos < 0) {
207 
208  switch (errno) {
209 
210  case EINTR:
211  case EWOULDBLOCK:
212  //case EAGAIN:
213  break;
214 
215  default:
216  THROW(JSocketException, "Socket read error " << getFileDescriptor() << ' ' << errno);
217  }
218 
219  pos = 0;
220  }
221 
222  return pos;
223  }
virtual int read(char *buffer, const int length)
Read data from file.
Definition: JFile.hh:80

◆ write()

virtual int JNET::JSocket::write ( const char *  buffer,
const int  length 
)
inlineoverridevirtualinherited

Write data to socket.

This method handles I/O errors in such a way that:

  1. the return value is set to zero if no data are written;
  2. an exception is thrown in case of a fatal error;
Parameters
bufferbuffer
lengthnumber of bytes to write
Returns
number of bytes actually written

Reimplemented from JLANG::JFile.

Reimplemented in JNET::JUDPSocket, and JNET::JSocketBlocking.

Definition at line 237 of file JSocket.hh.

238  {
239  int pos = JFile::write(buffer, length);
240 
241  if (pos == 0) {
242 
243  THROW(JSocketException, "Socket write failed " << getFileDescriptor() << ' ' << errno);
244 
245  } else if (pos < 0) {
246 
247  switch (errno) {
248 
249  case EINTR:
250  case EWOULDBLOCK:
251  //case EAGAIN:
252  break;
253 
254  default:
255  THROW(JSocketException, "Socket write error " << getFileDescriptor() << ' ' << errno);
256  }
257 
258  pos = 0;
259  }
260 
261  return pos;
262  }
virtual int write(const char *buffer, const int length)
Write data to file.
Definition: JFile.hh:93

◆ setOption()

template<class T >
void JNET::JSocket::setOption ( const int  level,
const int  option,
const T  value 
)
inlineprotectedinherited

Set socket option.

Parameters
levellevel
optionoption
valuevalue

Definition at line 274 of file JSocket.hh.

275  {
276  socklen_t size = sizeof(T);
277 
278  if (setsockopt(getFileDescriptor(), level, option, &value, size) < 0) {
279  THROW(JSocketException, "Set socket option failed " << errno);
280  }
281  }

◆ getOption()

template<class T >
T JNET::JSocket::getOption ( const int  level,
const int  option 
) const
inlineprotectedinherited

Get socket option.

Parameters
levellevel
optionoption
Returns
value

Definition at line 292 of file JSocket.hh.

293  {
294  T value;
295  socklen_t size = sizeof(T);
296 
297  if (getsockopt(getFileDescriptor(), level, option, &value, &size) < 0) {
298  THROW(JSocketException, "Get socket option failed " << errno);
299  }
300 
301  return value;
302  }

◆ close()

int JLANG::JFile::close ( )
inlineinherited

Close file.

Returns
return value

Definition at line 57 of file JFile.hh.

58  {
59  int value = -1;
60 
61  if (fileDescriptor != FILE_CLOSED) {
62 
63  value = ::close(fileDescriptor);
64 
66  result = 0;
67  }
68 
69  return value;
70  }
static const int FILE_CLOSED
int result
Definition: JFile.hh:170

◆ 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
timeouttimeout
Returns
true if ready to read; else false

Definition at line 106 of file JFile.hh.

107  {
108  return JFileDescriptorMask(*this).in_avail(timeout);
109  }
Auxiliary class for method select.
bool in_avail(JTimeval timeout=JTimeval::min())
Check availability of input.

◆ 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
timeouttimeout
Returns
true if ready to write; else false

Definition at line 119 of file JFile.hh.

120  {
121  return JFileDescriptorMask(*this).out_avail(timeout);
122  }
bool out_avail(JTimeval timeout=JTimeval::min())
Check availability of output.

◆ 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.

131  {
132  return is_open() && !eof() && !bad();
133  }
bool is_open() const
Get open status.
virtual bool bad() const
Check status.
Definition: JFile.hh:152
virtual bool eof() const
Check end of file.
Definition: JFile.hh:163

◆ 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.

142  {
143  return result == 0;
144  }

◆ 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.

153  {
154  return fail();
155  }
virtual bool fail() const
Check status.
Definition: JFile.hh:141

◆ 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.

164  {
165  return result == EOF;
166  }

◆ less()

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

Less than operation.

Parameters
fileJAbstractFile to be compared
Returns
true if this file descriptor is less; else false

Definition at line 64 of file JAbstractFile.hh.

65  {
66  return getFileDescriptor() < file.getFileDescriptor();
67  }

◆ getFileDescriptor()

int JLANG::JAbstractFile::getFileDescriptor ( ) const
inlineinherited

Get file descriptor.

Returns
file descriptor

Definition at line 75 of file JAbstractFile.hh.

76  {
77  return fileDescriptor;
78  }

◆ setFileDescriptor()

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

Set file descriptor.

Parameters
filefile descriptor

Definition at line 86 of file JAbstractFile.hh.

87  {
88  fileDescriptor = file;
89  }

◆ is_open()

bool JLANG::JAbstractFile::is_open ( ) const
inlineinherited

Get open status.

Definition at line 95 of file JAbstractFile.hh.

96  {
97  return fileDescriptor != FILE_CLOSED;
98  }

◆ 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.

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

◆ getSockaddr() [2/2]

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

Get sockaddr.

Returns
pointer to sockaddr structure

Definition at line 55 of file JSocketAddress.hh.

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

◆ getFamily()

int JNET::JSocketAddress::getFamily ( ) const
inlineinherited

Get family.

Returns
family

Definition at line 66 of file JSocketAddress.hh.

67  {
68  return sin_family;
69  }

◆ setFamily()

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

Set family.

Parameters
familyfamily

Definition at line 77 of file JSocketAddress.hh.

78  {
79  sin_family = family;
80  }

◆ getHostname()

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

Get host name.

Returns
host name

Definition at line 88 of file JSocketAddress.hh.

89  {
90  return JSYSTEM::getHostname(this->getIPnumber());
91  }
int getIPnumber() const
Get IP number.
std::string getHostname()
Get host name.
Definition: JNetwork.hh:77

◆ getIPnumber()

int JNET::JSocketAddress::getIPnumber ( ) const
inlineinherited

Get IP number.

Returns
IP number

Definition at line 99 of file JSocketAddress.hh.

100  {
101  return sin_addr.s_addr;
102  }

◆ setIPnumber() [1/2]

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

Set IP number.

Parameters
ip_numberIP number

Definition at line 110 of file JSocketAddress.hh.

111  {
112  sin_addr.s_addr = ip_number;
113  }

◆ setIPnumber() [2/2]

void JNET::JSocketAddress::setIPnumber ( )
inlineinherited

Set any IP number.

Definition at line 119 of file JSocketAddress.hh.

120  {
121  sin_addr.s_addr = htonl(INADDR_ANY);
122  }

◆ getPort()

int JNET::JSocketAddress::getPort ( ) const
inlineinherited

Get port number.

Returns
port number

Definition at line 130 of file JSocketAddress.hh.

131  {
132  return ntohs(this->sin_port);
133  }

◆ setPort()

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

Set port number.

Parameters
portport number

Definition at line 141 of file JSocketAddress.hh.

142  {
143  if (port >= 0 && port <= std::numeric_limits<u_short>::max())
144  sin_port = htons((u_short) port);
145  else
146  THROW(JCastException, "JSocketAddress::setPort() illegal value.");
147  }
Exception for cast operation.
Definition: JException.hh:252

◆ sizeOf()

static int JNET::JSocketAddress::sizeOf ( )
inlinestaticinherited

Get size of object.

Returns
number of bytes

Definition at line 155 of file JSocketAddress.hh.

156  {
157  return sizeof(sockaddr_in);
158  }

◆ hasNext()

template<class T >
virtual bool JLANG::JAbstractObjectIterator< T >::hasNext ( )
inlineoverridevirtualinherited

Check availability of next element.

Returns
true if the iteration has more elements; else false

Implements JLANG::JObjectIterator< T >.

Definition at line 56 of file JAbstractObjectIterator.hh.

57  {
58  if (!has_next) {
59  has_next = this->setObject(object);
60  }
61 
62  return has_next;
63  }
virtual bool setObject(T &object)=0
Set object.

◆ next()

template<class T >
virtual const pointer_type& JLANG::JAbstractObjectIterator< T >::next ( )
inlineoverridevirtualinherited

Get next element.

Returns
pointer to element

Implements JLANG::JObjectIterator< T >.

Definition at line 71 of file JAbstractObjectIterator.hh.

72  {
73  if (has_next)
74  ps.reset(&this->object);
75  else
76  ps.reset(NULL);
77 
78  has_next = false;
79 
80  return ps;
81  }
virtual void reset() override
Reset pointer.
Definition: JPointer.hh:84

◆ skip()

template<class T >
virtual skip_type JLANG::JObjectIterator< T >::skip ( const skip_type  ns)
inlinevirtualinherited

Skip items.

Parameters
nsnumber of items to skip
Returns
number of items skipped

Reimplemented in JLANG::JSTDObjectIterator< T >, JLANG::JPipe< T >, JLANG::JPipe< JTail_t >, JLANG::JPipe< JHead_t >, and JLANG::JAbstractObjectReader< T >.

Definition at line 90 of file JObjectIterator.hh.

91  {
92  skip_type i = 0;
93 
94  for ( ; i != ns && hasNext(); ++i) {
95  next();
96  }
97 
98  return i;
99  }
virtual const pointer_type & next()=0
Get next element.
virtual bool hasNext()=0
Check availability of next element.
unsigned int skip_type
Type definition for number of objects to skip.
std::vector< size_t > ns

Member Data Documentation

◆ select

template<class T >
JSelectReader JNET::JLigierObjectIterator< T >::select
private

Definition at line 152 of file JLigierObjectIterator.hh.

◆ buffer_size

template<class T >
int JNET::JLigierObjectIterator< T >::buffer_size
private

Definition at line 153 of file JLigierObjectIterator.hh.

◆ timeout_us

template<class T >
int JNET::JLigierObjectIterator< T >::timeout_us
private

Definition at line 154 of file JLigierObjectIterator.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.

◆ object

template<class T >
T JLANG::JAbstractObjectIterator< T >::object
protectedinherited

object

Definition at line 34 of file JAbstractObjectIterator.hh.

◆ has_next

template<class T >
bool JLANG::JAbstractObjectIterator< T >::has_next
protectedinherited

status

Definition at line 35 of file JAbstractObjectIterator.hh.

◆ ps

template<class T >
pointer_type JLANG::JAbstractObjectIterator< T >::ps
privateinherited

Definition at line 84 of file JAbstractObjectIterator.hh.


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