XmlRpc::XmlRpcSocket Class Reference

A platform-independent socket API. More...

#include <XmlRpcSocket.h>

Static Public Member Functions
static int	socket ()
	Creates a stream (TCP) socket. Returns -1 on failure.
static void	close (int socket)
	Closes a socket.
static bool	setNonBlocking (int socket)
	Sets a stream (TCP) socket to perform non-blocking IO. Returns false on failure.
static bool	nbRead (int socket, std::string &s, bool *eof)
	Read text from the specified socket. Returns false on error.
static bool	nbWrite (int socket, std::string &s, int *bytesSoFar)
	Write text to the specified socket. Returns false on error.
static bool	setReuseAddr (int socket)
static bool	bind (int socket, int port)
	Bind to a specified port.
static bool	listen (int socket, int backlog)
	Set socket in listen mode.
static int	accept (int socket)
	Accept a client connection request.
static bool	connect (int socket, std::string &host, int port)
	Connect a socket to a server (from a client)
static int	getError ()
	Returns last errno.
static std::string	getErrorMsg ()
	Returns message corresponding to last error.
static std::string	getErrorMsg (int error)
	Returns message corresponding to error.

Detailed Description

A platform-independent socket API.

Definition at line 17 of file XmlRpcSocket.h.

Member Function Documentation

accept()

int XmlRpcSocket::accept ( int  socket )

static

Accept a client connection request.

Definition at line 132 of file XmlRpcSocket.cpp.

{
  struct sockaddr_in addr;
#if defined(_WINDOWS)
  int
#else
  socklen_t
#endif
    addrlen = sizeof(addr);
 
  return (int) ::accept(fd, (struct sockaddr*)&addr, &addrlen);
}

Referenced by accept(), and XmlRpc::XmlRpcServer::acceptConnection().

bind()

bool XmlRpcSocket::bind ( int  socket, int  port  )

static

Bind to a specified port.

Definition at line 112 of file XmlRpcSocket.cpp.

{
  struct sockaddr_in saddr;
  memset(&saddr, 0, sizeof(saddr));
  saddr.sin_family = AF_INET;
  saddr.sin_addr.s_addr = htonl(INADDR_ANY);
  saddr.sin_port = htons((u_short) port);
  return (::bind(fd, (struct sockaddr *)&saddr, sizeof(saddr)) == 0);
}

Referenced by bind(), and XmlRpc::XmlRpcServer::bindAndListen().

close()

void XmlRpcSocket::close ( int  socket )

static

Closes a socket.

Definition at line 76 of file XmlRpcSocket.cpp.

{
  XmlRpcUtil::log(4, "XmlRpcSocket::close: fd %d.", fd);
#if defined(_WINDOWS)
  closesocket(fd);
#else
  ::close(fd);
#endif // _WINDOWS
}

Referenced by XmlRpc::XmlRpcServer::acceptConnection(), XmlRpc::XmlRpcSource::close(), and close().

connect()

bool XmlRpcSocket::connect ( int  socket, std::string &  host, int  port  )

static

Connect a socket to a server (from a client)

Definition at line 149 of file XmlRpcSocket.cpp.

{
  struct sockaddr_in saddr;
  memset(&saddr, 0, sizeof(saddr));
  saddr.sin_family = AF_INET;
 
  struct hostent *hp = gethostbyname(host.c_str());
  if (hp == 0) return false;
 
  saddr.sin_family = hp->h_addrtype;
  memcpy(&saddr.sin_addr, hp->h_addr, hp->h_length);
  saddr.sin_port = htons((u_short) port);
 
  // For asynch operation, this will return EWOULDBLOCK (windows) or
  // EINPROGRESS (linux) and we just need to wait for the socket to be writable...
  int result = ::connect(fd, (struct sockaddr *)&saddr, sizeof(saddr));
  return result == 0 || nonFatalError();
}

Referenced by connect(), and XmlRpc::XmlRpcClient::doConnect().

getError()

int XmlRpcSocket::getError ( )

static

Returns last errno.

Definition at line 235 of file XmlRpcSocket.cpp.

{
#if defined(_WINDOWS)
  return WSAGetLastError();
#else
  return errno;
#endif
}

Referenced by getErrorMsg().

getErrorMsg() [1/2]

std::string XmlRpcSocket::getErrorMsg ( )

static

Returns message corresponding to last error.

Definition at line 247 of file XmlRpcSocket.cpp.

{
  return getErrorMsg(getError());
}

Referenced by XmlRpc::XmlRpcServer::acceptConnection(), XmlRpc::XmlRpcServer::bindAndListen(), XmlRpc::XmlRpcClient::doConnect(), getErrorMsg(), XmlRpc::XmlRpcClient::handleEvent(), XmlRpc::XmlRpcClient::readHeader(), XmlRpc::XmlRpcServerConnection::readHeader(), XmlRpc::XmlRpcServerConnection::readRequest(), XmlRpc::XmlRpcClient::readResponse(), XmlRpc::XmlRpcClient::writeRequest(), and XmlRpc::XmlRpcServerConnection::writeResponse().

getErrorMsg() [2/2]

std::string XmlRpcSocket::getErrorMsg ( int  error )

static

Returns message corresponding to error.

Definition at line 254 of file XmlRpcSocket.cpp.

{
  char err[60];
  snprintf(err,sizeof(err),"error %d", error);
  return std::string(err);
}

listen()

bool XmlRpcSocket::listen ( int  socket, int  backlog  )

static

Set socket in listen mode.

Definition at line 125 of file XmlRpcSocket.cpp.

{
  return (::listen(fd, backlog) == 0);
}

Referenced by XmlRpc::XmlRpcServer::bindAndListen(), and listen().

nbRead()

bool XmlRpcSocket::nbRead ( int  socket, std::string &  s, bool *  eof  )

static

Read text from the specified socket. Returns false on error.

Definition at line 172 of file XmlRpcSocket.cpp.

{
  const int READ_SIZE = 4096;   // Number of bytes to attempt to read at a time
  char readBuf[READ_SIZE];
 
  bool wouldBlock = false;
  *eof = false;
 
  while ( ! wouldBlock && ! *eof) {
#if defined(_WINDOWS)
    int n = recv(fd, readBuf, READ_SIZE-1, 0);
#else
    int n = read(fd, readBuf, READ_SIZE-1);
#endif
    XmlRpcUtil::log(5, "XmlRpcSocket::nbRead: read/recv returned %d.", n);
 
    if (n > 0) {
      readBuf[n] = 0;
      s.append(readBuf, n);
    } else if (n == 0) {
      *eof = true;
    } else if (nonFatalError()) {
      wouldBlock = true;
    } else {
      return false;   // Error
    }
  }
  return true;
}

Referenced by XmlRpc::XmlRpcClient::readHeader(), XmlRpc::XmlRpcServerConnection::readHeader(), XmlRpc::XmlRpcServerConnection::readRequest(), and XmlRpc::XmlRpcClient::readResponse().

nbWrite()

bool XmlRpcSocket::nbWrite ( int  socket, std::string &  s, int *  bytesSoFar  )

static

Write text to the specified socket. Returns false on error.

Definition at line 205 of file XmlRpcSocket.cpp.

{
  int nToWrite = int(s.length()) - *bytesSoFar;
  char *sp = const_cast<char*>(s.c_str()) + *bytesSoFar;
  bool wouldBlock = false;
 
  while ( nToWrite > 0 && ! wouldBlock ) {
#if defined(_WINDOWS)
    int n = send(fd, sp, nToWrite, 0);
#else
    int n = write(fd, sp, nToWrite);
#endif
    XmlRpcUtil::log(5, "XmlRpcSocket::nbWrite: send/write returned %d.", n);
 
    if (n > 0) {
      sp += n;
      *bytesSoFar += n;
      nToWrite -= n;
    } else if (nonFatalError()) {
      wouldBlock = true;
    } else {
      return false;   // Error
    }
  }
  return true;
}

Referenced by XmlRpc::XmlRpcClient::writeRequest(), and XmlRpc::XmlRpcServerConnection::writeResponse().

setNonBlocking()

bool XmlRpcSocket::setNonBlocking ( int  socket )

static

Sets a stream (TCP) socket to perform non-blocking IO. Returns false on failure.

Definition at line 90 of file XmlRpcSocket.cpp.

{
#if defined(_WINDOWS)
  unsigned long flag = 1;
  return (ioctlsocket((SOCKET)fd, FIONBIO, &flag) == 0);
#else
  return (fcntl(fd, F_SETFL, O_NONBLOCK) == 0);
#endif // _WINDOWS
}

Referenced by XmlRpc::XmlRpcServer::acceptConnection(), XmlRpc::XmlRpcServer::bindAndListen(), and XmlRpc::XmlRpcClient::doConnect().

setReuseAddr()

bool XmlRpcSocket::setReuseAddr ( int  socket )

static

Allow the port the specified socket is bound to to be re-bound immediately so server re-starts are not delayed. Returns false on failure.

Definition at line 102 of file XmlRpcSocket.cpp.

{
  // Allow this port to be re-bound immediately so server re-starts are not delayed
  int sflag = 1;
  return (setsockopt(fd, SOL_SOCKET, SO_REUSEADDR, (const char *)&sflag, sizeof(sflag)) == 0);
}

Referenced by XmlRpc::XmlRpcServer::bindAndListen().

socket()

int XmlRpcSocket::socket ( )

static

Creates a stream (TCP) socket. Returns -1 on failure.

Definition at line 68 of file XmlRpcSocket.cpp.

{
  initWinSock();
  return (int) ::socket(AF_INET, SOCK_STREAM, 0);
}

Referenced by XmlRpc::XmlRpcServer::bindAndListen(), XmlRpc::XmlRpcClient::doConnect(), and socket().

---

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

• XmlRpcSocket.h
• XmlRpcSocket.cpp