sock.c File Reference

Socket services definitions. More...

#include <sys/types.h>
#include <sys/socket.h>
#include <sys/un.h>
#include <netinet/in.h>
#include <netdb.h>
#include <arpa/inet.h>
#include <unistd.h>
#include <fcntl.h>
#include <errno.h>
#include <string.h>
#include "rnr/rnrconfig.h"
#include "rnr/sock.h"
#include "rnr/simplebuf.h"
#include "rnr/log.h"
#include "rnr/new.h"

Go to the source code of this file.

Classes
struct	socket_t

Macros
#define	USE_IPV6
	enable IPV6 (Cygwin)
#define	HOST_NAME_MAX   64
	maximum host name length

Functions
static void	fdset_nowarn (int fd, fd_set *pset)
	FD_SET() wrapper with no annoying warnings. More...
static ushort_t	ntohs_nowarn (ushort_t huShort)
	ntohs() wrapper with no annoying warnings. More...
static ushort_t	htons_nowarn (ushort_t huShort)
	htons() wrapper with no annoying warnings. More...
static int	SockResolveHostName (const char *sHostName, struct in_addr *pAddrInet)
	Resolve host name into IP address (IPV4 only). More...
static char *	SocketAddrNameInet (int af, struct sockaddr *pAddr, const char *sHostName)
	Allocate formated internet name (IPV4, IPV6). More...
static char *	SocketAddrNameUnix (struct sockaddr_un *pAddrUnix, const char *sHostName)
	Allocate formated UNIX name. More...
static char *	SocketAddrName (struct sockaddr *pAddr, const char *sHostName)
	Allocate formated address name. More...
char *	SocketThisHostName ()
	Get the host string name of this network node (computer). More...
Socket_T *	SocketNew ()
	Allocate a new, unconnected socket. More...
void	SocketDelete (Socket_T *pSocket)
	Delate an allocated socket. More...
SimpleBuf_T *	SocketBufNewBuf (Socket_T *pSocket, int eIOBuf, size_t nBufSize)
	Allocate a socket buffer and attach to Socket. More...
SimpleBuf_T *	SocketBufSetBuf (Socket_T *pSocket, int eIOBuf, byte_t *pBuf, size_t nBufSize)
	Attach a buffer to Socket. More...
SimpleBuf_T *	SocketBufGetBuf (Socket_T *pSocket, int eIOBuf)
	Get Socket buffer. More...
byte_t *	SocketBufGetRawBuf (Socket_T *pSocket, int eIOBuf)
	Get Socket raw buffer. More...
size_t	SocketBufGetSize (Socket_T *pSocket, int eIOBuf)
	Get Socket buffer size. More...
size_t	SocketBufGetLen (Socket_T *pSocket, int eIOBuf)
	Get number of bytes in Socket buffer. More...
void	SocketBufClear (Socket_T *pSocket, int eIOBuf)
	Clear a Socket buffer. More...
void *	SocketAttrGetClientData (Socket_T *pSocket)
	Get Socket client user data. More...
void	SocketAttrSetClientData (Socket_T *pSocket, void *pClientData)
	Get Socket client user data. More...
const char *	SocketAttrGetLocalName (Socket_T *pSocket)
	Get Socket local name. More...
void	SocketAttrSetLocalName (Socket_T *pSocket, const char *sHostName)
	Set Socket local name. More...
const char *	SocketAttrGetRemoteName (Socket_T *pSocket)
	Get Socket remote name. More...
void	SocketAttrSetRemoteName (Socket_T *pSocket, struct sockaddr *pAddr, const char *sHostName)
	Set Socket remote name. More...
int	SocketAttrGetSd (Socket_T *pSocket)
	Get Socket socket (file) descriptor. More...
void	SocketAttrSetSd (Socket_T *pSocket, int sd)
	Set Socket socket (file) descriptor. More...
int	SocketAttrGetPort (Socket_T *pSocket)
	Get Socket port number. More...
void	SocketAttrSetPort (Socket_T *pSocket, int ipPort)
	Set Socket port number. More...
SockFlavor	SocketAttrGetFlavor (Socket_T *pSocket)
	Get Socket flavor. More...
void	SocketAttrSetFlavor (Socket_T *pSocket, SockFlavor eFlavor)
	Set Socket flavor. More...
bool_t	SocketAttrHasFlavor (Socket_T *pSocket, int nMask, int nFlavor)
	Check if Socket has an assigned flavor. More...
int	SocketAttrSetNonBlocking (Socket_T *pSocket)
	Set Socket for non-blockiong I/O. More...
bool_t	SocketStateIsOpen (Socket_T *pSocket)
	Check if Socket is open. More...
bool_t	SocketStateIsErrored (Socket_T *pSocket)
	Check if Socket is in some kind of errored state. More...
Socket_T *	SocketOpenTcpListener (int ipPortListener, const char *sLocalHostName)
	Create and open a new TCP/IP passive listener socket on this host. More...
Socket_T *	SocketOpenTcpConnection (const char *sRemoteHostName, int ipPortRemote)
	Create and open a new TCP/IP socket to the given remote host and port. More...
Socket_T *	SocketOpenUdp (int ipPortUdp, const char *sLocalHostName)
	Create and open a new UDP/IP connectionless socket. port. More...
Socket_T *	SocketOpenUnix (int ipPortUdp, int nType)
	Create and open a new UNIX connectionless socket. More...
Socket_T *	SocketOpenUnixPair (int nType)
	Create and open a new UNIX pair socket. More...
Socket_T *	SocketAccept (Socket_T *pSocketListener, bool_t bNonBlock)
	Accept a client connection requst from the listener socket. More...
int	SocketClose (Socket_T *pSocket)
	Close a Socket. More...
ssize_t	SocketRead (Socket_T *pSocket)
	Reads the next available bytes from the Socket into in the Socket's read buffer. More...
ssize_t	SocketWrite (Socket_T *pSocket)
	Writes the bytes from the Socket's write buffer to the Socket connection. More...
ssize_t	SocketWriteAll (Socket_T *pSocket)
	Writes all of the bytes from the socket's write buffer until no more bytes or error. More...

Variables
const char *	SockStrClosed = "** Closed **"
	closed socket More...
const char *	SockStrDisconnected = "** Disconnected **"
	disconnected
const char *	SockStrAnyHost = "ANYHOST"
	any host
const char *	SockStrLocalHost = "LOCALHOST"
	local host
const char *	SockStrUnknownHost = "UNKNOWNHOST"
	unknown host

Detailed Description

Socket services definitions.

LastChangedDate

2012-07-10 12:37:42 -0600 (Tue, 10 Jul 2012)

Rev

2078

These socket functions were inspired by the camserv socket.c functions written by Jon Travis (see below).

Todo:

Socket_T *SocketOpenUnix(int ipPortUdp, int nType)

Socket_T *SocketOpenUnixPair(int nType)

fix cygwin shortcommings.

Author

Robin Knight (robin.nosp@m..kni.nosp@m.ght@r.nosp@m.oadn.nosp@m.arrow.nosp@m.s.co.nosp@m.m)

Copyright

© 2005-2018. RoadNarrows LLC..
http://www.roadnarrows.com
All Rights Reserved

---

Original Source and Copyright:

Original Author:

Jon Travis (jtrav.nosp@m.is@p.nosp@m.00p.o.nosp@m.rg)

---

Definition in file sock.c.

Function Documentation

static void fdset_nowarn ( int  fd, fd_set *  pset  )

inlinestatic

FD_SET() wrapper with no annoying warnings.

Parameters

fd	File descriptor to add to set.
pset	Pointer to fd set.

Definition at line 95 of file sock.c.

References PRAGMA_IGNORED, and PRAGMA_WARNING.

{
  FD_SET(fd, pset);
}

static ushort_t htons_nowarn ( ushort_t  huShort )

inlinestatic

htons() wrapper with no annoying warnings.

Parameters

huShort

Unsigned short integer.

Returns

Network byte order.

Definition at line 117 of file sock.c.

References PRAGMA_WARNING.

Referenced by SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  return htons(huShort);
}

static ushort_t ntohs_nowarn ( ushort_t  huShort )

inlinestatic

ntohs() wrapper with no annoying warnings.

Parameters

huShort

Unsigned short integer.

Returns

Host byte order.

Definition at line 107 of file sock.c.

Referenced by SocketAddrNameInet().

{
  return ntohs(huShort);
}

Socket_T* SocketAccept	(	Socket_T *	pSocketListener,
		bool_t	bNonBlock
	)

Accept a client connection requst from the listener socket.

The new socket will be set to non-blocking I/O mode if requested.

Parameters

pSocketListener	Pointer to open listener socket.
bNonBlock	Do [not] set socket to non-blocking.

Return Value: Newly allocated and accepted open Socket_T pointer on success, NULL on failure.

Definition at line 1240 of file sock.c.

References LOGDIAG4, LOGDIAG4CALL, LOGERROR, LOGSYSERROR, socket_t::m_sd, socket_t::m_sLocalName, NULL, SocketAttrGetRemoteName(), SocketAttrSetFlavor(), SocketAttrSetLocalName(), SocketAttrSetNonBlocking(), SocketAttrSetPort(), SocketAttrSetRemoteName(), SocketAttrSetSd(), SocketClose(), SocketDelete(), SocketNew(), SockFlavorDomainIPv4, SockFlavorFuncConnection, and SockFlavorProtocolTcp.

Referenced by SocketAttrIsConnectionless().

{
  int                 sd;
  struct sockaddr     saddr;
  unsigned int        addrlen = sizeof(saddr);
  Socket_T           *pSocket;

  LOGDIAG4CALL("pSocketListener->%s", pSocketListener->m_sLocalName);

  // accept incoming connection
  if((sd = accept(pSocketListener->m_sd, &saddr, (socklen_t *)&addrlen)) == -1)
  {
    LOGSYSERROR("accept(%d,...)", pSocketListener->m_sd);
    return NULL;
  }

  //
  // Now create a new socket and set the appropriate attributes
  //
  pSocket = SocketNew();

  SocketAttrSetSd(pSocket, sd);
  SocketAttrSetPort(pSocket, ((struct sockaddr_in*)&saddr)->sin_port);
  SocketAttrSetFlavor(pSocket, 
      SockFlavorDomainIPv4|SockFlavorProtocolTcp|SockFlavorFuncConnection);
  SocketAttrSetLocalName(pSocket, NULL);
  SocketAttrSetRemoteName(pSocket, &saddr, NULL); 

  // set non-blocking
  if( bNonBlock )
  {
    if( SocketAttrSetNonBlocking(pSocket) == -1 )
    {
      LOGERROR("SockAttrSetNonBlocking() failed");
      SocketClose(pSocket);
      SocketDelete(pSocket);
      return NULL;
    }
  }

  LOGDIAG4("Accepted connection from %s", SocketAttrGetRemoteName(pSocket));

  return pSocket;
}

static char* SocketAddrName ( struct sockaddr *  pAddr, const char *  sHostName  )

static

Allocate formated address name.

Generated Name Format:

* addrname:
*    addrname_inet
*    addrname_unix
* 

Parameters

pAddr	Socket address.
sHostName	Host name. NULLL to force lookup.

Returns

Returns pointer to allocated name string.

Definition at line 347 of file sock.c.

References new_strdup(), SocketAddrNameInet(), and SocketAddrNameUnix().

Referenced by SocketAttrSetLocalName(), and SocketAttrSetRemoteName().

{
  int   af;

  af = pAddr->sa_family;

  switch(af)
  {
    case AF_INET:
    case AF_INET6:
      return SocketAddrNameInet(af, pAddr, sHostName);
    case AF_UNIX:
      return SocketAddrNameUnix((struct sockaddr_un *)pAddr, sHostName);
    default:
      return new_strdup("AF???");
  }
}

static char* SocketAddrNameInet ( int  af, struct sockaddr *  pAddr, const char *  sHostName  )

static

Allocate formated internet name (IPV4, IPV6).

Generated Name Format:

* addrname_inet:
*    hostname '('dottedaddr')'
*    hostname '('dottedaddr port')'
* hostname:
*    given
*    lookup
*    dottedaddr
* dottedaddr:
*    ipv4_format
*    ipv6_format
* port: 
*    ':' number
* 

Parameters

af	Internet socket protocol family.
pAddr	Socket address.
sHostName	Host name. NULLL to force lookup.

Returns

Returns pointer to allocated name string.

Definition at line 204 of file sock.c.

References LOGSYSERROR, NEWSTR, ntohs_nowarn(), NULL, and SockStrAnyHost.

Referenced by SocketAddrName().

{
  void   *pAddrIn;
  size_t  nAddrSize;
  char    bufAddr[INET6_ADDRSTRLEN];
  uint_t  uPort;
  char    bufPort[16];
  char    bufHost[NI_MAXHOST];
  char   *sHost;
  char   *sAddrName;

  bufAddr[0] = 0;
  bufPort[0] = 0;
  bufHost[0] = 0;

  // ipv4
  if( af == AF_INET )
  {
    nAddrSize = sizeof(struct sockaddr_in);
    pAddrIn = &(((struct sockaddr_in *)pAddr)->sin_addr);
    uPort = (uint_t)(((struct sockaddr_in *)pAddr)->sin_port);
  }
  // ipv6
  else if( af == AF_INET6 )
  {
    nAddrSize = sizeof(struct sockaddr_in6);
    pAddrIn = &(((struct sockaddr_in6 *)pAddr)->sin6_addr);
    uPort = (uint_t)(((struct sockaddr_in6 *)pAddr)->sin6_port);
  }
  // bug
  else
  {
    return NULL;
  }

  // dotted address
  if( inet_ntop(af, pAddrIn, bufAddr, (socklen_t)sizeof(bufAddr)) != NULL )
  {
    if( uPort != 0 )
    {
      snprintf(bufPort, sizeof(bufPort), ":%hu", ntohs_nowarn((ushort_t)uPort));
      bufPort[sizeof(bufPort)-1] = 0;
    }
  }
  else
  {
    LOGSYSERROR("inet_ntop(%d, ...)", af);
    strcpy(bufAddr, "ADDR???");
  }

  // use given hostname
  if( sHostName != NULL )
  {
    sHost = (char *)sHostName;
  }
 
  // any host address
  else if(   (af == AF_INET) 
          && (((struct in_addr *)pAddrIn)->s_addr == INADDR_ANY) )
  {
    sHost = (char *)SockStrAnyHost;
  }

  // lookup hostname (makes dotted if cannot find)
  else
  {
    sHost = bufHost;
    getnameinfo(pAddr, (socklen_t)nAddrSize,
                bufHost, (socklen_t)sizeof(bufHost),
                NULL, (socklen_t)0, NI_NOFQDN);
  }

  sAddrName = NEWSTR(strlen(sHost)+strlen(bufAddr)+strlen(bufPort)+3);

  sprintf(sAddrName, "%s(%s%s)", sHost, bufAddr, bufPort);

  return sAddrName;
}

static char* SocketAddrNameUnix ( struct sockaddr_un *  pAddrUnix, const char *  sHostName  )

static

Allocate formated UNIX name.

Generated Name Format:

* addrname_unix:
*    hostname '('unixpath')'
* hostname:
*    given
*    localhost
*    "LOCALHOST"
* 

Parameters

pAddrUnix	UNIX socket address.
sHostName	Host name. NULLL to force lookup.

Returns

Returns pointer to allocated name string.

Definition at line 303 of file sock.c.

References NEWSTR, NULL, and SockStrLocalHost.

Referenced by SocketAddrName().

{
  char    bufHost[NI_MAXHOST];
  char   *sHost;
  char   *sAddrName;

  // use given hostname
  if( sHostName != NULL )
  {
    sHost = (char *)sHostName;
  }
  // lookup local hostname
  else if( gethostname(bufHost, sizeof(bufHost)) < 0 )
  {
    sHost = bufHost;
  }
  else
  {
    sHost = (char *)SockStrLocalHost;
  }

  sAddrName = NEWSTR(strlen(sHost)+strlen(pAddrUnix->sun_path)+3);

  sprintf(sAddrName, "%s(%s)", sHost, pAddrUnix->sun_path);

  return sAddrName;
}

void* SocketAttrGetClientData

(

Socket_T *

pSocket

)

Get Socket client user data.

Parameters

pSocket

Pointer to Socket.

Returns

Returns pointer to user defined data.

Definition at line 607 of file sock.c.

References CHKPTR, socket_t::m_pClientData, and NULL.

{
  CHKPTR(pSocket, NULL);
  return pSocket->m_pClientData;
}

SockFlavor SocketAttrGetFlavor

(

Socket_T *

pSocket

)

Get Socket flavor.

Parameters

pSocket

Pointer to Socket.

Returns

Returns flavor enumeration.

Definition at line 788 of file sock.c.

References CHKPTR, socket_t::m_eFlavor, and SockFlavorUndef.

{
  CHKPTR(pSocket, SockFlavorUndef);
  return pSocket->m_eFlavor;
}

const char* SocketAttrGetLocalName

(

Socket_T *

pSocket

)

Get Socket local name.

Parameters

pSocket

Pointer to Socket.

Returns

Returns string.

Definition at line 632 of file sock.c.

References CHKPTR, socket_t::m_sLocalName, and NULL.

Referenced by SocketClose(), SocketOpenTcpListener(), SocketOpenUdp(), SocketWriteAll(), SockSetAdd(), SockSetChkSd(), and SockSetRemove().

{
  CHKPTR(pSocket, NULL);
  return pSocket->m_sLocalName;
}

int SocketAttrGetPort

(

Socket_T *

pSocket

)

Get Socket port number.

Parameters

pSocket

Pointer to Socket.

Returns

Returns port number.

Definition at line 763 of file sock.c.

References CHKPTR, socket_t::m_ipPort, and SOCK_PORT_NONE.

{
  CHKPTR(pSocket, SOCK_PORT_NONE);
  return pSocket->m_ipPort;
}

const char* SocketAttrGetRemoteName

(

Socket_T *

pSocket

)

Get Socket remote name.

Parameters

pSocket

Pointer to Socket.

Returns

Returns string.

Definition at line 682 of file sock.c.

References CHKPTR, socket_t::m_sRemoteName, and NULL.

Referenced by SocketAccept(), SocketClose(), SocketOpenTcpConnection(), and SocketWriteAll().

{
  CHKPTR(pSocket, NULL);
  return pSocket->m_sRemoteName;
}

int SocketAttrGetSd

(

Socket_T *

pSocket

)

Get Socket socket (file) descriptor.

Parameters

pSocket

Pointer to Socket.

Returns

Returns socket descriptor.

Definition at line 735 of file sock.c.

References CHKPTR, socket_t::m_sd, and SOCK_SD_CLOSED.

Referenced by SockSetChkSd().

{
  CHKPTR(pSocket, SOCK_SD_CLOSED);
  return pSocket->m_sd;
}

bool_t SocketAttrHasFlavor	(	Socket_T *	pSocket,
		int	nMask,
		int	nFlavor
	)

Check if Socket has an assigned flavor.

Parameters

pSocket	Pointer to Socket.
nMask	Flavor mask of relevant bits.
nFlavor	Flavor bits.

Returns

Returns true or false.

Definition at line 815 of file sock.c.

References CHKPTR, socket_t::m_eFlavor, socket_t::m_sd, and SOCK_SD_CLOSED.

Referenced by SocketAttrIsConnection(), and SocketAttrIsListener().

{
  CHKPTR(pSocket, false);

  // flavors only apply to open sockets
  if( pSocket->m_sd == SOCK_SD_CLOSED )
  {
    return false;
  }
  else
  {
    return ((int)(pSocket->m_eFlavor) & nMask) == nFlavor? true: false;
  }
}

void SocketAttrSetClientData	(	Socket_T *	pSocket,
		void *	pClientData
	)

Get Socket client user data.

Parameters

pSocket	Pointer to Socket.
pClientData	User defined data.

Definition at line 619 of file sock.c.

References CHKPTR, and socket_t::m_pClientData.

{
  CHKPTR(pSocket);
  pSocket->m_pClientData = pClientData;
}

void SocketAttrSetFlavor	(	Socket_T *	pSocket,
		SockFlavor	eFlavor
	)

Set Socket flavor.

Parameters

pSocket	Pointer to Socket.
eFlavor	Flavor enumeration.

Definition at line 800 of file sock.c.

References CHKPTR, and socket_t::m_eFlavor.

Referenced by SocketAccept(), SocketClose(), SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  CHKPTR(pSocket);
  pSocket->m_eFlavor = eFlavor;
}

void SocketAttrSetLocalName	(	Socket_T *	pSocket,
		const char *	sHostName
	)

Set Socket local name.

Parameters

pSocket	Pointer to Socket.
sHostName	Local host name string.

Definition at line 644 of file sock.c.

References CHKPTR, LOGSYSERROR, socket_t::m_sd, socket_t::m_sLocalName, new_strdup(), SocketAddrName(), SocketStateIsOpen(), and SockStrClosed.

Referenced by SocketAccept(), SocketClose(), SocketNew(), SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  struct sockaddr_un addr;    // largest address size (is there a better way?)
  socklen_t          sizAddr;

  CHKPTR(pSocket);

  delete(pSocket->m_sLocalName);

  sizAddr = (socklen_t)sizeof(addr);

  // closed
  if( !SocketStateIsOpen(pSocket) )
  {
    pSocket->m_sLocalName = new_strdup(SockStrClosed);
  }

  // error leg - simply use host name
  else if( getsockname(pSocket->m_sd, (struct sockaddr *)&addr, &sizAddr) < 0 )
  {
    LOGSYSERROR("getsockname(%d, ...)", pSocket->m_sd);
    pSocket->m_sLocalName = new_strdup(sHostName);
  }

  // get local address
  else 
  {
    pSocket->m_sLocalName = SocketAddrName((struct sockaddr *)&addr, sHostName);
  }
}

int SocketAttrSetNonBlocking

(

Socket_T *

pSocket

)

Set Socket for non-blockiong I/O.

Parameters

pSocket

Pointer to Socket.

Returns

Returns 0 on success, < 0 on failure.

Definition at line 837 of file sock.c.

References CHKPTR, LOGDIAG3, LOGSYSERROR, socket_t::m_sd, and OK.

Referenced by SocketAccept(), and SocketAttrIsConnectionless().

{
  CHKPTR(pSocket, -1);

  if( fcntl(pSocket->m_sd, F_SETFL, O_NONBLOCK) < 0 )
  {
    LOGSYSERROR("fcntl(%d,F_SETFL,O_NONBLOCK)", pSocket->m_sd);
    return -1;
  }
  return OK;
}

void SocketAttrSetPort	(	Socket_T *	pSocket,
		int	ipPort
	)

Set Socket port number.

Parameters

pSocket	Pointer to Socket.
ipPort	Port number.

Definition at line 775 of file sock.c.

References CHKPTR, and socket_t::m_ipPort.

Referenced by SocketAccept().

{
  CHKPTR(pSocket);
  pSocket->m_ipPort = ipPort;
}

void SocketAttrSetRemoteName	(	Socket_T *	pSocket,
		struct sockaddr *	pAddr,
		const char *	sHostName
	)

Set Socket remote name.

Parameters

pSocket	Pointer to Socket.
pAddr	Socket address.
sHostName	Remote host name string.

Definition at line 695 of file sock.c.

References CHKPTR, socket_t::m_sRemoteName, new_strdup(), NULL, SocketAddrName(), SocketStateIsOpen(), and SockStrDisconnected.

Referenced by SocketAccept(), SocketClose(), SocketNew(), SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  CHKPTR(pSocket);

  delete(pSocket->m_sRemoteName);

  // closed
  if( !SocketStateIsOpen(pSocket) )
  {
    pSocket->m_sRemoteName = new_strdup(SockStrDisconnected);
  }

  // set preferred address named
  else if( pAddr != NULL )
  {
    pSocket->m_sRemoteName = SocketAddrName(pAddr, sHostName);
  }

  // simply use host name
  else if( sHostName != NULL )
  {
    pSocket->m_sRemoteName = new_strdup(sHostName);
  }

  // error
  else
  {
    pSocket->m_sRemoteName = new_strdup(SockStrDisconnected);
  }
}

void SocketAttrSetSd	(	Socket_T *	pSocket,
		int	sd
	)

Set Socket socket (file) descriptor.

Parameters

pSocket	Pointer to Socket.
sd	Socket descriptor.

Definition at line 747 of file sock.c.

References CHKPTR, socket_t::m_sd, and SocketClose().

Referenced by SocketAccept(), SocketClose(), SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  CHKPTR(pSocket);
  if( (pSocket->m_sd = sd) < 0 )
  {
    SocketClose(pSocket);
  }
}

void SocketBufClear	(	Socket_T *	pSocket,
		int	eIOBuf
	)

Clear a Socket buffer.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.

Definition at line 587 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, SimpleBufClear(), and SOCK_CHK_IO.

{
  CHKPTR(pSocket);
  SOCK_CHK_IO(eIOBuf);

  SimpleBufClear(pSocket->m_pIOBuf[eIOBuf]);
}

SimpleBuf_T* SocketBufGetBuf	(	Socket_T *	pSocket,
		int	eIOBuf
	)

Get Socket buffer.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.

Returns

Returns pointer to simplebuffer.

Definition at line 525 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, NULL, and SOCK_CHK_IO.

{
  CHKPTR(pSocket, NULL);
  SOCK_CHK_IO(eIOBuf, NULL);

  return pSocket->m_pIOBuf[eIOBuf];
}

size_t SocketBufGetLen	(	Socket_T *	pSocket,
		int	eIOBuf
	)

Get number of bytes in Socket buffer.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.

Returns

Returns number of bytes currently in buffer.

Definition at line 573 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, SimpleBufHasLen(), and SOCK_CHK_IO.

{
  CHKPTR(pSocket, (size_t)0);
  SOCK_CHK_IO(eIOBuf, (size_t)0);

  return SimpleBufHasLen(pSocket->m_pIOBuf[eIOBuf]);
}

byte_t* SocketBufGetRawBuf	(	Socket_T *	pSocket,
		int	eIOBuf
	)

Get Socket raw buffer.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.

Returns

Returns pointer to byte buffer.

Definition at line 541 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, SimpleBuf_T::m_pRWBuf, NULL, and SOCK_CHK_IO.

{
  CHKPTR(pSocket, NULL);
  SOCK_CHK_IO(eIOBuf, NULL);

  return pSocket->m_pIOBuf[eIOBuf]->m_pRWBuf;
}

size_t SocketBufGetSize	(	Socket_T *	pSocket,
		int	eIOBuf
	)

Get Socket buffer size.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.

Returns

Returns size of buffer in bytes.

Definition at line 557 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, SimpleBufHasSize(), and SOCK_CHK_IO.

{
  CHKPTR(pSocket, (size_t)0);
  SOCK_CHK_IO(eIOBuf, (size_t)0);

  return SimpleBufHasSize(pSocket->m_pIOBuf[eIOBuf]);
}

SimpleBuf_T* SocketBufNewBuf	(	Socket_T *	pSocket,
		int	eIOBuf,
		size_t	nBufSize
	)

Allocate a socket buffer and attach to Socket.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.
nBufSize	Buffer size (bytes).

Returns

Returns pointer to newly allocated buffer.

Definition at line 485 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, NULL, SimpleBufDelete(), SimpleBufNewWithBuf(), and SOCK_CHK_IO.

{
  CHKPTR(pSocket, NULL);
  SOCK_CHK_IO(eIOBuf, NULL);

  SimpleBufDelete(pSocket->m_pIOBuf[eIOBuf]);
  pSocket->m_pIOBuf[eIOBuf]  = SimpleBufNewWithBuf(nBufSize);
  return pSocket->m_pIOBuf[eIOBuf];
}

SimpleBuf_T* SocketBufSetBuf	(	Socket_T *	pSocket,
		int	eIOBuf,
		byte_t *	pBuf,
		size_t	nBufSize
	)

Attach a buffer to Socket.

Parameters

pSocket	Pointer to Socket.
eIOBuf	One of: SOCK_IO_READ SOCK_IO_WRITE.
pBuf	Pointer to buffer.
nBufSize	Buffer size (bytes).

Returns

Returns pointer to buffer.

Definition at line 505 of file sock.c.

References CHKPTR, socket_t::m_pIOBuf, NULL, SimpleBufSetBuf(), and SOCK_CHK_IO.

{
  CHKPTR(pSocket, NULL);
  SOCK_CHK_IO(eIOBuf, NULL);

  SimpleBufSetBuf(pSocket->m_pIOBuf[eIOBuf], pBuf, nBufSize, (size_t)0);
  return pSocket->m_pIOBuf[eIOBuf];
}

int SocketClose

(

Socket_T *

pSocket

)

Close a Socket.

Parameters

pSocket

Pointer to Socket.

Returns

Returns 0 on success, < 0 on failure.

Definition at line 1292 of file sock.c.

References CHKPTR, LOGDIAG4, LOGSYSERROR, socket_t::m_sd, NULL, SOCK_SD_CLOSED, SocketAttrGetLocalName(), SocketAttrGetRemoteName(), SocketAttrIsConnection(), SocketAttrSetFlavor(), SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SocketAttrSetSd(), SockFlavorUndef, SockStrClosed, and SockStrDisconnected.

Referenced by SocketAccept(), SocketAttrIsConnectionless(), SocketAttrSetSd(), and SocketWriteAll().

{
  CHKPTR(pSocket, -1);

  if( pSocket->m_sd != SOCK_SD_CLOSED )
  {
    shutdown(pSocket->m_sd, SHUT_RDWR);

    if( close(pSocket->m_sd) < 0 )
    {
      LOGSYSERROR("close(%d)", pSocket->m_sd);
    }

    if( SocketAttrIsConnection(pSocket) )
    {
      LOGDIAG4("Closed Connection %s", SocketAttrGetRemoteName(pSocket));
    }
    else
    {
      LOGDIAG4("Closed Socket %s", SocketAttrGetLocalName(pSocket));
    }

    SocketAttrSetSd(pSocket, SOCK_SD_CLOSED);
    SocketAttrSetFlavor(pSocket, SockFlavorUndef);
    SocketAttrSetLocalName(pSocket, SockStrClosed);
    SocketAttrSetRemoteName(pSocket, NULL, SockStrDisconnected);
  }

  return 0;
}

void SocketDelete

(

Socket_T *

pSocket

)

Delate an allocated socket.

Warning

Socket should be closed.

Definition at line 457 of file sock.c.

References socket_t::m_pIOBuf, socket_t::m_sLocalName, socket_t::m_sRemoteName, NULL, SimpleBufDelete(), SOCK_IO_READ, and SOCK_IO_WRITE.

Referenced by SocketAccept(), and SocketWriteAll().

{
  if( pSocket == NULL )
  {
    return;
  }

  delete(pSocket->m_sLocalName);
  delete(pSocket->m_sRemoteName);
  SimpleBufDelete(pSocket->m_pIOBuf[SOCK_IO_READ]);
  SimpleBufDelete(pSocket->m_pIOBuf[SOCK_IO_WRITE]);
  delete(pSocket);
}

Socket_T* SocketNew

(

)

Allocate a new, unconnected socket.

Returns

Returns pointer to allocated Socket_T *.

Definition at line 433 of file sock.c.

References socket_t::m_eFlavor, socket_t::m_ipPort, socket_t::m_pClientData, socket_t::m_pIOBuf, socket_t::m_sd, NEW, NULL, SimpleBufNew(), SOCK_IO_READ, SOCK_IO_WRITE, SOCK_PORT_NONE, SOCK_SD_CLOSED, SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SockFlavorUndef, SockStrClosed, and SockStrDisconnected.

Referenced by SocketAccept(), SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  Socket_T  *pSocket = NEW(Socket_T);

  pSocket->m_sd               = SOCK_SD_CLOSED;
  pSocket->m_ipPort           = SOCK_PORT_NONE;
  pSocket->m_eFlavor          = SockFlavorUndef;

  SocketAttrSetLocalName(pSocket, SockStrClosed);
  SocketAttrSetRemoteName(pSocket, NULL, SockStrDisconnected);

  pSocket->m_pIOBuf[SOCK_IO_READ]  = SimpleBufNew();
  pSocket->m_pIOBuf[SOCK_IO_WRITE] = SimpleBufNew();

  pSocket->m_pClientData      = NULL;

  return pSocket;
}

Socket_T* SocketOpenTcpConnection	(	const char *	sRemoteHostName,
		int	ipPortRemote
	)

Create and open a new TCP/IP socket to the given remote host and port.

Parameters

sRemoteHostName	Dotted address or network name.
ipPortRemote	Remote port number.

Returns

Returns a new TCP Socket_T pointer on success, NULL on failure.

Definition at line 1059 of file sock.c.

References htons_nowarn(), LOGDIAG4, LOGERROR, LOGSYSERROR, NULL, SocketAttrGetRemoteName(), SocketAttrSetFlavor(), SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SocketAttrSetSd(), SocketNew(), SockFlavorDomainIPv4, SockFlavorFuncConnection, SockFlavorProtocolTcp, and SockResolveHostName().

Referenced by SocketAttrIsConnectionless(), and SocketWriteAll().

{
  int                 sd;
  struct sockaddr_in  addrInet;
  Socket_T           *pSocket;

  //
  // Create socket in protocal familiy INET (IPv4), of type STREAM (TCP).
  //
  if( (sd = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0 )
  {
    LOGSYSERROR("socket(%d,%d,%d)", PF_INET, SOCK_STREAM, IPPROTO_TCP);
    return NULL;
  }

  //
  // Set IPv4 address of remote 
  //
  addrInet.sin_family = AF_INET;                    // ip application family
  addrInet.sin_port   = htons_nowarn((ushort_t)ipPortRemote);
                                                    // remote port number

  if( SockResolveHostName(sRemoteHostName, &(addrInet.sin_addr)) < 0 )
  {
    LOGERROR("SockResolveHostName() failed");
    close(sd);
    return NULL;
  }

  //
  // Connect to remote end
  //
  if(connect(sd, (struct sockaddr *)&addrInet, (socklen_t)sizeof(addrInet)) < 0)
  {
    LOGSYSERROR("connect(%d, ...)", sd);
    close(sd);
    return NULL;
  }

  //
  // Now create a new socket and set the appropriate attributes
  //
  pSocket = SocketNew();

  SocketAttrSetSd(pSocket, sd);
  SocketAttrSetFlavor(pSocket, 
      SockFlavorDomainIPv4|SockFlavorProtocolTcp|SockFlavorFuncConnection);
  SocketAttrSetLocalName(pSocket, NULL);
  SocketAttrSetRemoteName(pSocket, (struct sockaddr *)&addrInet, 
                          sRemoteHostName);

  LOGDIAG4("Opened Connection %s", SocketAttrGetRemoteName(pSocket));

  return pSocket;
}

Socket_T* SocketOpenTcpListener	(	int	ipPortListener,
		const char *	sLocalHostName
	)

Create and open a new TCP/IP passive listener socket on this host.

Parameters

ipPortListener	Port number to listen on.
sLocalHostName	String name of local host to bind to. If NULL, then this host will automatically choose the IP address.

Returns

: Returns a new listener Socket_T pointer on success, NULL on failure.

Definition at line 942 of file sock.c.

References _TINT, _TSTR, htons_nowarn(), LOGDIAG4, LOGDIAG4CALL, LOGERROR, LOGSYSERROR, NULL, SocketAttrGetLocalName(), SocketAttrSetFlavor(), SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SocketAttrSetSd(), SocketNew(), SockFlavorDomainIPv4, SockFlavorFuncListener, SockFlavorProtocolTcp, SockResolveHostName(), and SockStrAnyHost.

Referenced by SocketAttrIsConnectionless(), and SocketWriteAll().

{
  int                 sd;
  struct sockaddr_in  addrInet;
  int                 backlog = 8;
  int                 nVal;
  Socket_T           *pSocket;

  LOGDIAG4CALL(_TINT(ipPortListener), _TSTR(sLocalHostName));

  //
  // Create socket in protocal familiy INET (IPv4), of type STREAM (TCP).
  //
  if( (sd = socket(PF_INET, SOCK_STREAM, IPPROTO_TCP)) < 0 )
  {
    LOGSYSERROR("socket(%d,%d,%d)", PF_INET, SOCK_STREAM, IPPROTO_TCP);
    return NULL;
  }

  //
  // Disallow binding if another local task already listening on this address.
  // After socking binding and listen, then this sock option will disallow 
  // binding from any task to this port on any local address. 
  // Note: Non-critacal, so continue on errors.
  //
  nVal = 1;
  if( setsockopt(sd, SOL_SOCKET, SO_REUSEADDR,
                     &nVal, (socklen_t)sizeof(nVal)) < 0 )
  {
    LOGSYSERROR("setsockopt(%d,SOL_SOCKET,SO_REUSEADDR)",  sd);
  }

  //
  // Enable sending of keep-alive messages on connection-oriented sockets.
  // Note: Non-critacal, so continue on errors.
  //
  nVal = 1;
  if( setsockopt(sd, SOL_SOCKET, SO_KEEPALIVE,
                     &nVal, (socklen_t)sizeof(nVal)) < 0 )
  {
    LOGSYSERROR("setsockopt(%d,SOL_SOCKET,SO_KEEPALIVE)",  sd);
  }

  //
  // Bind this socket to application family INET (IP) at the given port.
  //
  addrInet.sin_family = AF_INET;                // ip application family
  addrInet.sin_port   = htons_nowarn((uint16_t)ipPortListener);
                                                // listen port number

  //
  // Let bind() automatically fill in the IP address of the machine where
  // the calling process is running on.
  // 
  if( sLocalHostName == NULL )
  {
    addrInet.sin_addr.s_addr = htonl(INADDR_ANY);
  }

  //
  // Bind to a specific local address
  //
  else if( SockResolveHostName(sLocalHostName, &(addrInet.sin_addr)) < 0 )
  {
    LOGERROR("SockResolveHostName() failed");
    close(sd);
    return NULL;
  }

  //
  // Bind socket to the address.
  //
  if( bind(sd, (struct sockaddr *)&addrInet, (socklen_t)sizeof(addrInet)) < 0 )
  {
    LOGSYSERROR("bind(%d, ...)", sd);
    close(sd);
    return NULL;
  }

  //
  // Mark this bound socket as a listener for new incoming connections that 
  // can then be accepted. The backlog is the maximum queue length of pending
  // connection requests.
  //
  if( listen(sd, backlog) < 0 )
  {
    LOGSYSERROR("listen(%d,%d)", sd, backlog);
    close(sd);
    return NULL;
  }

  //
  // Now create a new socket and set the appropriate attributes
  //
  pSocket = SocketNew();

  SocketAttrSetSd(pSocket, sd);
  SocketAttrSetFlavor(pSocket, 
      SockFlavorDomainIPv4|SockFlavorProtocolTcp|SockFlavorFuncListener);
  SocketAttrSetLocalName(pSocket, NULL);
  SocketAttrSetRemoteName(pSocket, NULL, SockStrAnyHost);

  LOGDIAG4("Opened Socket Listener on %s", SocketAttrGetLocalName(pSocket));

  return pSocket;
}

Socket_T* SocketOpenUdp	(	int	ipPortUdp,
		const char *	sLocalHostName
	)

Create and open a new UDP/IP connectionless socket. port.

Parameters

ipPortUdp	Binding UDP port number.
sLocalHostName	String name of local host to bind to. If NULL, then this host will automatically choose the IP address.

Returns

Returns a new UDP Socket_T pointer on success, NULL on failure.

Definition at line 1126 of file sock.c.

References _TINT, _TSTR, htons_nowarn(), LOGDIAG4, LOGDIAG4CALL, LOGERROR, LOGSYSERROR, NULL, SocketAttrGetLocalName(), SocketAttrSetFlavor(), SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SocketAttrSetSd(), SocketNew(), SockFlavorDomainIPv4, SockFlavorProtocolUdp, SockResolveHostName(), and SockStrAnyHost.

Referenced by SocketAttrIsConnectionless(), and SocketWriteAll().

{
  int                 sd;
  struct sockaddr_in  addrInet;
  Socket_T           *pSocket;

  LOGDIAG4CALL(_TINT(ipPortUdp), _TSTR(sLocalHostName));

  //
  // Create socket in protocal familiy INET (IPv4), of type DateGram (UDP).
  //
  if( (sd = socket(PF_INET, SOCK_DGRAM, IPPROTO_UDP)) < 0 )
  {
    LOGSYSERROR("socket(%d,%d,%d)", PF_INET, SOCK_DGRAM, IPPROTO_UDP);
    return NULL;
  }

  //
  // Bind this socket to application family INET (IP) at the given port.
  //
  memset((void*)&addrInet, 0, sizeof(addrInet));
  addrInet.sin_family = AF_INET;                  // ip application family
  addrInet.sin_port   = htons_nowarn((ushort_t)ipPortUdp);
                                                  // listen port number

  
  //
  // Let bind() automatically fill in the IP address of the machine where
  // the calling process is running on.
  // 
  if( sLocalHostName == NULL )
  {
    addrInet.sin_addr.s_addr = htonl(INADDR_ANY);
  }

  //
  // Bind to a specific local address
  //
  else if( SockResolveHostName(sLocalHostName, &(addrInet.sin_addr)) < 0 )
  {
    LOGERROR("SockResolveHostName() failed");
    close(sd);
    return NULL;
  }

  //
  // Bind socket to the address.
  //
  if( bind(sd, (struct sockaddr *)&addrInet, (socklen_t)sizeof(addrInet)) < 0 )
  {
    LOGSYSERROR("bind(%d, ...)", sd);
    close(sd);
    return NULL;
  }

  //
  // Now create a new socket and set the appropriate attributes
  //
  pSocket = SocketNew();

  SocketAttrSetSd(pSocket, sd);
  SocketAttrSetFlavor(pSocket, 
      SockFlavorDomainIPv4|SockFlavorProtocolUdp);
  SocketAttrSetLocalName(pSocket, NULL);
  SocketAttrSetRemoteName(pSocket, NULL, SockStrAnyHost);

  LOGDIAG4("Opened UDP Socket %s", SocketAttrGetLocalName(pSocket));

  return pSocket;
}

Socket_T* SocketOpenUnix	(	int	ipPortUdp,
		int	nType
	)

Create and open a new UNIX connectionless socket.

Todo:

Create and open a new UNIX connectionless socket.

Parameters

ipPortUdp	Binding UDP port number.
nType	Type of...

Returns

Returns a new UNIX Socket_T pointer on success, NULL on failure.

Definition at line 1208 of file sock.c.

References NULL.

Referenced by SocketAttrIsConnectionless().

{
  return NULL;
}

Socket_T* SocketOpenUnixPair

(

int

nType

)

Create and open a new UNIX pair socket.

Todo:

Create and open a new UNIX pair socket.

Parameters

nType

Type of...

Returns

Returns a new UNIX Socket_T pointer on success, NULL on failure.

Definition at line 1223 of file sock.c.

References NULL.

Referenced by SocketAttrIsConnectionless().

{
  return NULL;
}

ssize_t SocketRead

(

Socket_T *

pSocket

)

Reads the next available bytes from the Socket into in the Socket's read buffer.

Note

Read are from the connection to the read buffer.

Parameters

pSocket

Pointer to Socket.

Returns

Number of bytes read on success (may be zero if a timeout or an interupt occurred). Returns < 0 (RC_SOCK_E*) return code on error.

Definition at line 1340 of file sock.c.

References CHKPTR, LOGDIAG4, LOGERROR, LOGSYSERROR, socket_t::m_pIOBuf, SimpleBuf_T::m_pRWBuf, socket_t::m_sd, socket_t::m_sLocalName, SIMPLEBUF_REL, SimpleBufGetWritePtr(), SimpleBufHasAvail(), SimpleBufWriteSeek(), SOCK_IO_READ, SOCK_RC_EBADSD, SOCK_RC_EBADSOCK, SOCK_RC_EBUFFULL, SOCK_RC_ENOBUF, SOCK_RC_ESYSERR, and SocketStateIsOpen().

Referenced by SocketAttrIsConnectionless().

{
  SimpleBuf_T *pBuf;
  size_t       nBytes;
  ssize_t      nRead;

  CHKPTR(pSocket, SOCK_RC_EBADSOCK);
  
  // socket isn't open
  if( !SocketStateIsOpen(pSocket) )
  {
    LOGERROR("Socket %s is not open for reading", pSocket->m_sLocalName);
    return SOCK_RC_EBADSD;
  }

  // socket's simple read buffer
  pBuf = pSocket->m_pIOBuf[SOCK_IO_READ];

  // no read buffer present
  CHKPTR(pBuf, SOCK_RC_ENOBUF);
  CHKPTR(pBuf->m_pRWBuf, SOCK_RC_ENOBUF);

  // bytes remaining available in buffer
  nBytes = SimpleBufHasAvail(pBuf);

  // read buffer is full
  if( nBytes == 0 )
  {
    return SOCK_RC_EBUFFULL;
  }

  // read
  nRead = read(pSocket->m_sd, SimpleBufGetWritePtr(pBuf), nBytes);

  LOGDIAG4("SocketRead: read()=%d", nRead);

  // system error occurred - interpret
  if( nRead < 0 )
  {
    switch(errno)
    {
      case EAGAIN:  // non-blocking, but read would have caused blocking
      case EINTR:   // read was interrupted
        return 0;
      default:
        LOGSYSERROR("read()");
        return SOCK_RC_ESYSERR;
    }
  }

  SimpleBufWriteSeek(pBuf, (size_t)nRead, SIMPLEBUF_REL);

  return nRead;
}

bool_t SocketStateIsErrored

(

Socket_T *

pSocket

)

Check if Socket is in some kind of errored state.

The fcntl() non-blocking function is used to test the socket.

Parameters

pSocket

Pointer to Socket.

Returns

Returns true or false.

Definition at line 909 of file sock.c.

References socket_t::m_sd, NULL, and SOCK_SD_CLOSED.

Referenced by SocketAttrIsConnectionless().

{
  int fopts = 0;

  if( (pSocket == NULL) || (pSocket->m_sd == SOCK_SD_CLOSED) )
  {
    return false;
  }
  else if( fcntl(pSocket->m_sd, F_GETFL, &fopts) >= 0 )
  {
    return false;
  }
  else
  {
    return true;
  }
}

bool_t SocketStateIsOpen

(

Socket_T *

pSocket

)

Check if Socket is open.

Parameters

pSocket

Pointer to Socket.

Returns

Returns true or false.

Definition at line 888 of file sock.c.

References socket_t::m_sd, NULL, and SOCK_SD_CLOSED.

Referenced by SocketAttrIsConnectionless(), SocketAttrSetLocalName(), SocketAttrSetRemoteName(), SocketRead(), SocketWrite(), and SockSetChkSd().

{
  if( pSocket == NULL )
  {
    return false;
  }
  else
  {
    return pSocket->m_sd == SOCK_SD_CLOSED? false: true;
  }
}

char* SocketThisHostName

(

)

Get the host string name of this network node (computer).

Returns

Returns pointer to allocated name string.

Definition at line 379 of file sock.c.

References HOST_NAME_MAX, LOGERROR, LOGSYSERROR, new_strdup(), NEWSTR, NULL, and SockStrUnknownHost.

{
  char             sHostName[HOST_NAME_MAX];
  char             sAddr[INET6_ADDRSTRLEN];
  struct hostent  *pHostEntry;
  char            *p;

  // get the host name of this processor
  if( gethostname(sHostName, sizeof(sHostName)) == -1 )
  {
    LOGSYSERROR("gethostname(...)");
    return new_strdup(SockStrUnknownHost);
  }
  sHostName[sizeof(sHostName)-1] = 0;

  // get this host entry info
  if( (pHostEntry = gethostbyname(sHostName)) == NULL )
  {
    LOGERROR("gethostbyname(%s): %s", sHostName, hstrerror(h_errno));
    return new_strdup(sHostName);
  }

  // dotted address to string
  if( pHostEntry->h_addr_list  && pHostEntry->h_addr_list[0] )
  {
    if( inet_ntop(pHostEntry->h_addrtype, pHostEntry->h_addr_list[0],
                  sAddr, (socklen_t)sizeof(sAddr)) == NULL )
    {
      LOGSYSERROR("inet_ntop(%d, ...)", pHostEntry->h_addrtype);
      strcpy(sAddr, "ADDR???");
    }
  }
  else
  {
    strcpy(sAddr, "ADDR???");
  }
  sAddr[sizeof(sAddr)-1] = 0;

  p = NEWSTR(strlen(sHostName)+strlen(sAddr)+2);
  sprintf(p, "%s(%s)", sHostName, sAddr);

  return p;
}

ssize_t SocketWrite

(

Socket_T *

pSocket

)

Writes the bytes from the Socket's write buffer to the Socket connection.

Only one write attempt is made.

Note

Writes are from the Socket write buffer.

Parameters

pSocket

Pointer to Socket.

Returns

Number of bytes written on success (may be zero if a timeout or an interupt occurred). Returns < 0 (RC_SOCK_E*) return code on error.

Definition at line 1409 of file sock.c.

References CHKPTR, LOGERROR, LOGSYSERROR, socket_t::m_pIOBuf, SimpleBuf_T::m_pRWBuf, socket_t::m_sd, SIMPLEBUF_REL, SimpleBufGetReadPtr(), SimpleBufHasLen(), SimpleBufReadSeek(), SOCK_IO_WRITE, SOCK_RC_EBADSD, SOCK_RC_EBADSOCK, SOCK_RC_ENOBUF, SOCK_RC_ESYSERR, SOCK_RC_IODONE, and SocketStateIsOpen().

Referenced by SocketAttrIsConnectionless(), and SocketWriteAll().

{
  SimpleBuf_T *pBuf;
  size_t       nBytes;
  ssize_t      nWritten;

  CHKPTR(pSocket, SOCK_RC_EBADSOCK);
  
  // socket isn't open
  if( !SocketStateIsOpen(pSocket) )
  {
    LOGERROR("Socket is not open for writing");
    return SOCK_RC_EBADSD;
  }

  // socket's simple read buffer
  pBuf = pSocket->m_pIOBuf[SOCK_IO_WRITE];

  // no write buffer present
  CHKPTR(pBuf, SOCK_RC_ENOBUF);
  CHKPTR(pBuf->m_pRWBuf, SOCK_RC_ENOBUF);

  // bytes in buffer
  nBytes = SimpleBufHasLen(pBuf);

  // read buffer is empty - finished writing this buffer
  if( nBytes == 0 )
  {
    return SOCK_RC_IODONE;
  }
  
  // write
  nWritten = write(pSocket->m_sd, SimpleBufGetReadPtr(pBuf), nBytes);

  // system error occurred - interpret
  if( nWritten < 0 )
  {
    switch(errno)
    {
      case EAGAIN:  // non-blocking, but write would have caused blocking
      case EINTR:   // write was interrupted
        return 0;
      default:
        LOGSYSERROR("write()");
        return SOCK_RC_ESYSERR;
    }
  }

  SimpleBufReadSeek(pBuf, (size_t)nWritten, SIMPLEBUF_REL);

  return nWritten;
}

ssize_t SocketWriteAll

(

Socket_T *

pSocket

)

Writes all of the bytes from the socket's write buffer until no more bytes or error.

Parameters

pSocket

Pointer to Socket.

Returns

Number of bytes written on success. Returns < 0 (RC_SOCK_E*) return code on error.

Definition at line 1472 of file sock.c.

References LOGDIAG4, LOGERROR, NULL, SOCK_RC_IODONE, SocketAttrGetLocalName(), SocketAttrGetRemoteName(), SocketClose(), SocketDelete(), SocketOpenTcpConnection(), SocketOpenTcpListener(), SocketOpenUdp(), and SocketWrite().

Referenced by SocketAttrIsConnectionless().

{
  ssize_t n, nWritten=0;

  // write all of the bytes in the buffer
  while( (n = SocketWrite(pSocket)) >= 0 )
  {
    nWritten += n;
  }

  // all bytes have been 
  if( n == SOCK_RC_IODONE )
  {
    return nWritten;
  }

  // error occurred
  else
  {
    return n;
  }
}

static int SockResolveHostName ( const char *  sHostName, struct in_addr *  pAddrInet  )

static

Resolve host name into IP address (IPV4 only).

Parameters

sHostName	Host name in dotted or DNS network format.
pAddrInet	IP address

Returns

Returns 0 on success, -1 on failure.

Definition at line 155 of file sock.c.

References LOGERROR, NULL, and OK.

Referenced by SocketOpenTcpConnection(), SocketOpenTcpListener(), and SocketOpenUdp().

{
  struct hostent  *pHostEntry;
  struct in_addr   addrInet;

  // hostname: "www.xxx.yyy.zzz" (IPv4)
  if( inet_aton(sHostName, &addrInet) != 0 )
  {
    memcpy(pAddrInet, &addrInet, sizeof(addrInet));
  }
  // hostname: "www.xxx.yyy.zzz" (IPv4) or "networkname" (may use DNS)
  else if( (pHostEntry = gethostbyname(sHostName)) != NULL )
  {
    memcpy(pAddrInet, pHostEntry->h_addr, (size_t)pHostEntry->h_length);
  }
  else
  {
    LOGERROR("gethostbyname(%s): %s", sHostName, hstrerror(h_errno));
    return -1; 
  }

  return OK;
}

Variable Documentation

const char* SockStrClosed = "** Closed **"

closed socket

Special Host Names

Definition at line 127 of file sock.c.

Referenced by SocketAttrSetLocalName(), SocketClose(), and SocketNew().