ost::Socket - The Socket is used as the base for all Internet protocol services under Common C++.

       Generated automatically by Doxygen for GNU CommonC++ from the source code.

GNU CommonC++                                    Sun Dec 27 2020                                  ost::Socket(3)

ost::Socket::Socket(intdomain,inttype,intprotocol=0)[protected]
       An  unconnected socket may be created directly on the local machine. Sockets can occupy both the internet
       domain (AF_INET) and UNIX socket domain (AF_UNIX) under unix. The socket type  (SOCK_STREAM,  SOCK_DGRAM)
       and protocol may also be specified. If the socket cannot be created, an exception is thrown.

       Parametersdomain socket domain to use.
           type base type and protocol family of the socket.
           protocol specific protocol to apply.

   ost::Socket::Socket(SOCKETfd)[protected]
       A  socket  object may be created from a file descriptor when that descriptor was created either through a
       socket() or accept() call. This constructor is mostly for internal use.

       Parametersfd file descriptor of an already existing socket.

   ost::Socket::Socket()[protected]
       Create an inactive socket object for base constructors.

   ost::Socket::Socket(constSocket&source)[protected]
       A socket can also be constructed from an already existing Socket object. On  POSIX  systems,  the  socket
       file descriptor is dup()'d. On Win32, DuplicateHandle() is used.

       Parameterssource of existing socket to clone.

   virtualost::Socket::~Socket()[virtual]
       The  socket  base  class  may  be  'thrown' as a result of an error, and the 'catcher' may then choose to
       destroy the object. By assuring the socket base class is a virtual destructor, we  can  assure  the  full
       object is properly terminated.

       The Socket is used as the base for all Internet protocol services under Common C++.

       A socket is a system resource (or winsock descriptor) that occupies a specific port address (and may be
       bound to a specific network interface) on the local machine. The socket may also be directly connected to
       a specific socket on a remote internet host.

       This base class is not directly used, but is provided to offer properties common to other Common C++
       socket classes, including the socket exception model and the ability to set socket properties such as
       QoS, 'sockopts' properties like Dont-Route and Keep-Alive, etc.

       Author
           David Sugar dyfet@ostel.com

       base class of all sockets.

       Examplestcpthread.cpp.

SOCKETdupSocket(SOCKETs,Socket::Statestate)[friend]

boolost::Socket::broadcastboolost::Socket::completionstruct{...}ost::Socket::flags[protected]boolost::Socket::keepaliveboolost::Socket::lingerboolost::Socket::loopbackboolost::Socket::multicastMutexost::Socket::mutex[static],[protected]boolost::Socket::routeSOCKETvolatileost::Socket::so[protected]
       the  actual  socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way
       madness lies -- jfc

   Statevolatileost::Socket::state[protected]boolost::Socket::thrownunsignedost::Socket::ttl

enumost::Socket::ErrorEnumeratorerrSuccesserrCreateFailederrCopyFailederrInputerrInputInterrupterrResourceFailureerrOutputerrOutputInterrupterrNotConnectederrConnectRefusederrConnectRejectederrConnectTimeouterrConnectFailederrConnectInvaliderrConnectBusyerrConnectNoRouteerrBindingFailederrBroadcastDeniederrRoutingDeniederrKeepaliveDeniederrServiceDeniederrServiceUnavailableerrMulticastDisablederrTimeouterrNoDelayerrExtendederrLookupFailerrSearchErrerrInvalidValueenumost::Socket::FamilyEnumeratorIPV6IPV4enumost::Socket::PendingEnumeratorpendingInputpendingOutputpendingErrorenumost::Socket::State[protected]EnumeratorINITIALAVAILABLEBOUNDCONNECTEDCONNECTINGSTREAMenumost::Socket::TosEnumeratortosLowDelaytosThroughputtosReliabilitytosMinCosttosInvalid

Errorost::Socket::bufferSize(unsignedsize)[protected]
       Set the total protocol stack network kernel buffer size for both send and receive together.

       Returns
           errSuccess on success

       Parameterssize of buffer.

   staticboolost::Socket::check(Familyfam)[static]
       See if a specific protocol family is available in the current runtime environment.

       Returns
           true if family available.

   Errorost::Socket::connectError(void)[protected]
       Used as a common handler for connection failure processing.

       Returns
           correct failure code to apply.

   Errorost::Socket::drop(constIPV4Multicast&ia)[protected]
       Drop membership from a multicast group.

       Returns
           0 (errSuccess) on success, else error code.

       Parametersia address of multicast group to drop.

       Referenced by ost::UDPReceive::drop().

   Errorost::Socket::drop(constIPV6Multicast&ia)[protected]voidost::Socket::endSocket(void)[protected]
       Used as the default destructor for ending a socket. This will cleanly terminate the socket connection. It
       is provided for use in derived virtual destructors.

       Referenced by ost::UDPReceive::endReceiver(), and ost::UDPTransmit::endTransmitter().

   voidost::Socket::error(constchar*err)const[inline],[protected]
       This service is used to throw application defined socket errors where the application specific error code
       is a string.

       Parameterserr string or message to pass.

       References ost::error().

   Errorost::Socket::error(Errorerror,constchar*err=NULL,longsystemError=0)const[protected]
       This service is used to throw all socket errors which usually occur during the socket constructor.

       Parameterserror defined socket error id.
           err string or message to pass.
           systemError the system error# that caused the error

   Errorost::Socket::getErrorNumber(void)const[inline]
       Often used by a 'catch' to fetch the last error of a thrown socket.

       Returns
           error number of Error error.

       Examplestcpthread.cpp.

   constchar*ost::Socket::getErrorString(void)const[inline]
       Often used by a 'catch' to fetch the user set error string of a thrown socket, but only if EXTENDED error
       codes are used.

       Returns
           string for error message.

   IPV4Hostost::Socket::getIPV4Local(tpport_t*port=NULL)const
       Get the local address and port number this socket is currently bound to.

       Parametersport ptr to port number on local host.

       Returns
           host address of interface this socket is bound to.

       Referenced by ost::TCPSocket::getLocal().

   IPV4Hostost::Socket::getIPV4NAT(tpport_t*port=NULL)const
       Perform  NAT table lookup for this socket. Used to allow an application to know the original ip:port pair
       the the client 'thinks'  it  is  connecting  to.  Used  mostly  to  transparently  impersonate  a  remote
       server/service.

       On  error,  0.0.0.0:0 is returned and one of the following error codes is set: errServiceUnavailable - if
       nat is not supported on the current platform or if it was  not  compiled;  errLookupFail  -  if  the  nat
       syscall  failed  for  some  reason  (extended error code); errSearchErr - if the socket does not have nat
       information (i.e. is not nated).

       NAT lookup is supported on NetFilter for ipv4 and ipv6 (Linux), IPFilter for ipv4 (Solaris,  *BSD  except
       OpenBSD,  HP-UX,  etc.)  and  Packet  Filter  for  ipv4 and ipv6 (OpenBSD). When using IPFilter or Packet
       Filter, the first NAT lookup must be performed as root (the NAT device is  read  only  for  root  and  is
       opened once, unless an error occurs). Permissions on the nat device may be changed to solve this.

       Warning
           When  using IPFilter and Packet Filter, application data model must be the same as the running kernel
           (32/64 bits).

       Parametersport ptr to NATed port number on local host.

       Returns
           NATed host address that this socket is related to.

   IPV4Hostost::Socket::getIPV4Peer(tpport_t*port=NULL)const
       Get the host address and port of the socket this socket is connected to. If the socket is  currently  not
       in a connected state, then a host address of 0.0.0.0 is returned.

       Parametersport ptr to port number of remote socket.

       Returns
           host address of remote socket.

   virtualIPV4Hostost::Socket::getIPV4Sender(tpport_t*port=NULL)const[virtual]
       May be used to examine the origin of data waiting in the socket receive queue. This can tell a TCP server
       where pending 'connect' requests are coming from, or a UDP socket where it's next packet arrived from.

       Parametersport ptr to port number of sender.

       Returns
           host address, test with 'isInetAddress()'.

       Reimplemented in ost::DCCPSocket.

       Referenced by ost::TCPSocket::getRequest().

   IPV6Hostost::Socket::getIPV6Local(tpport_t*port=NULL)const
       Referenced by ost::TCPV6Socket::getLocal().

   IPV6Hostost::Socket::getIPV6NAT(tpport_t*port=NULL)constIPV6Hostost::Socket::getIPV6Peer(tpport_t*port=NULL)constvirtualIPV6Hostost::Socket::getIPV6Sender(tpport_t*port=NULL)const[virtual]
       Reimplemented in ost::DCCPSocket.

       Referenced by ost::TCPV6Socket::getRequest().

   IPV4Hostost::Socket::getLocal(tpport_t*port=NULL)const[inline]IPV4Hostost::Socket::getNAT(tpport_t*port)const[inline]IPV4Hostost::Socket::getPeer(tpport_t*port=NULL)const[inline]Examplestcp.cpp, and tcpthread.cpp.

   IPV4Hostost::Socket::getSender(tpport_t*port=NULL)const[inline]longost::Socket::getSystemError(void)const[inline]constchar*ost::Socket::getSystemErrorString(void)constboolost::Socket::isActive(void)const
       Test to see if the socket is at least operating or if it is mearly initialized. 'initialized' sockets may
       be the result of failed constructors.

       Returns
           true if not in initial state.

   boolost::Socket::isBroadcast(void)const[inline]
       Return if broadcast has been enabled for the specified socket.

       Returns
           true if broadcast socket.

   boolost::Socket::isConnected(void)const
       Can  test to see if this socket is 'connected', and hence whether a 'catch' can safely call getPeer(). Of
       course, an unconnected socket will return a 0.0.0.0 address from getPeer() as well.

       Returns
           true when socket is connected to a peer.

   virtualboolost::Socket::isPending(Pendingpend,timeout_ttimeout=TIMEOUT_INF)[virtual]
       Get the status of pending operations. This can be used to examine if input or output is waiting, or if an
       error has occured on the descriptor.

       Returns
           true if ready, false on timeout.

       Parameterspend ready check to perform.
           timeout in milliseconds, inf. if not specified.

       Reimplemented in ost::UnixStream, ost::SimpleTCPStream, and ost::TCPStream.

       Referenced         by         ost::UDPReceive::isInputReady(),         ost::UDPTransmit::isOutputReady(),
       ost::DCCPSocket::isPendingConnection(),                            ost::TCPSocket::isPendingConnection(),
       ost::TCPV6Socket::isPendingConnection(),           ost::UnixSocket::isPendingConnection(),            and
       ost::UDPReceive::isPendingReceive().

   boolost::Socket::isRouted(void)const[inline]
       Return if socket routing is enabled.

       Returns
           true if routing enabled.

   Errorost::Socket::join(constIPV4Multicast&ia)[protected]
       Join a multicast group.

       Returns
           0 (errSuccess) on success, else error code.

       Parametersia address of multicast group to join.

       Referenced by ost::UDPReceive::join().

   Errorost::Socket::join(constIPV6Multicast&ia)[protected]boolost::Socket::operator!()const
       Operator based testing to see if a socket is currently active.

   Socket&ost::Socket::operator=(constSocket&from)
       Sockets may also be duplicated by the assignment operator.

   virtualssize_tost::Socket::readData(void*buf,size_tlen,charseparator=0,timeout_tt=0)[protected],[virtual]
       Read in a block of len bytes with specific separator. Can be zero, or any other char. If \n or  \r,  it's
       treated just like a readLine(). Otherwise it looks for the separator.

       Parametersbuf pointer to byte allocation.
           len maximum length to read.
           separator separator for a particular ASCII character
           t timeout for pending data in milliseconds.

       Returns
           number of bytes actually read.

       Reimplemented in ost::SSLStream.

   ssize_tost::Socket::readLine(char*buf,size_tlen,timeout_ttimeout=0)[protected]Process a logical input line from a socket descriptor directly.

       Parametersbuf pointer to string.
           len maximum length to read.
           timeout for pending data in milliseconds.

       Returns
           number of bytes actually read.

   Errorost::Socket::receiveBuffer(unsignedsize)[protected]
       Set the protocol stack network kernel receive buffer size associated with the socket.

       Returns
           errSuccess on success, or error.

       Parameterssize of buffer in bytes.

   Errorost::Socket::receiveLimit(intlimit=1)[protected]
       Set thr receive limit.

   Errorost::Socket::receiveTimeout(timeout_ttimer)[protected]
       Receive timeout for receiving raw network data.

       Returns
           errSuccess if set.

       Parameterstimer value in milliseconds.

   Errorost::Socket::sendBuffer(unsignedsize)[protected]
       Set the protocol stack network kernel send buffer size associated with the socket.

       Returns
           errSuccess on success, or error.

       Parameterssize of buffer in bytes.

   Errorost::Socket::sendLimit(intlimit=2048)[protected]
       Set the send limit.

   Errorost::Socket::sendTimeout(timeout_ttimer)[protected]
       Set the send timeout for sending raw network data.

       Returns
           errSuccess if set.

       Parameterstimer value in millisec.

   Errorost::Socket::setBroadcast(boolenable)[protected]
       Set  the  subnet  broadcast flag for the socket. This enables sending to a subnet and may require special
       image privileges depending on the operating system.

       Returns
           0 (errSuccess) on success, else error code.

       Parametersenable when set to true.

       Referenced by ost::UDPTransmit::setBroadcast().

   voidost::Socket::setCompletion(boolimmediate)
       Used  to  specify  blocking  mode  for  the  socket.  A  socket  can  be  made  non-blocking  by  setting
       setCompletion(false)  or  set to block on all access with setCompletion(true). I do not believe this form
       of non-blocking socket I/O is supported in winsock, though it provides an alternate asynchronous  set  of
       socket services.

       Parametersimmediate mode specify socket I/O call blocking mode.

   voidost::Socket::setError(boolenable)[inline],[protected]
       This  service  is  used to turn the error handler on or off for 'throwing' exceptions by manipulating the
       thrown flag.

       Parametersenable true to enable handler.

   Errorost::Socket::setKeepAlive(boolenable)
       Set the keep-alive status of this socket and if keep-alive messages will be sent.

       Returns
           0 on success.

       Parametersenable keep alive messages.

   Errorost::Socket::setLinger(boollinger)
       Enable lingering sockets on close.

       Parameterslinger specify linger enable.

   Errorost::Socket::setLoopbackByFamily(boolenable,Familyfamily=IPV4)[protected]
       Set the multicast loopback flag for the socket. Loopback enables a socket to hear what it is sending.

       Returns
           0 (errSuccess) on success, else error code.

       Parametersenable when set to true.
           family of protocol.

       Referenced by ost::UDPSocket::setLoopback().

   Errorost::Socket::setMulticastByFamily(boolenable,Familyfamily=IPV4)[protected]
       Setting multicast binds the multicast interface used for the socket to the interface  the  socket  itself
       has  been  implicitly  bound to. It is also used as a check flag to make sure multicast is enabled before
       multicast operations are used.

       Returns
           0 (errSuccess) on success, else error code.

       Parametersenable when set to true.
           family of protocol.

       Referenced      by      ost::UDPSocket::setMulticast(),       ost::UDPTransmit::setMulticast(),       and
       ost::UDPReceive::setMulticast().

   Errorost::Socket::setNoDelay(boolenable)[protected]
       Enable/disable delaying packets (Nagle algorithm)

       Returns
           0 on success.

       Parametersenable disable Nagle algorithm when set to true.

   Errorost::Socket::setRouting(boolenable)[protected]
       Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).

       Returns
           0 on success.

       Parametersenable normal routing when set to true.

       Referenced by ost::UDPTransmit::setRouting(), and ost::UDPReceive::setRouting().

   Errorost::Socket::setTimeToLiveByFamily(unsignedcharttl,Familyfam=IPV4)[protected]
       Set the multicast time to live for a multicast socket.

       Returns
           0 (errSuccess) on success, else error code.

       Parametersttl time to live.
           fam family of protocol.

       Referenced by ost::UDPSocket::setTimeToLive(), and ost::UDPTransmit::setTimeToLive().

   Errorost::Socket::setTypeOfService(Tosservice)
       Set  packet  scheduling  on  platforms  which support ip quality of service conventions. This effects how
       packets in the queue are scheduled through the interface.

       Returns
           0 on success, error code on failure.

       Parametersservice type of service enumerated type.

       Referenced by ost::UDPTransmit::setTypeOfService().

   virtualssize_tost::Socket::writeData(constvoid*buf,size_tlen,timeout_tt=0)[protected],[virtual]
       Write a block of len bytes to socket.

       Parametersbuf pointer to byte allocation.
           len maximum length to write.
           t timeout for pending data in milliseconds.

       Returns
           number of bytes actually written.

typedefenumErrorost::Socket::ErrortypedefenumFamilyost::Socket::FamilytypedefenumPendingost::Socket::PendingtypedefenumStateost::Socket::State[protected]typedefenumTosost::Socket::Tos

       ost::Socket - The Socket is used as the base for all Internet protocol services under Common C++.

       #include <socket.h>

       Inherited by ost::DCCPSocket, ost::SimpleTCPStream, ost::SocketPort, ost::TCPSocket [protected],
       ost::TCPStream, ost::TCPV6Socket [protected], ost::UDPSocket, ost::UnixSocket [protected], and
       ost::UnixStream.

   PublicTypes
       enum Family { IPV6 = AF_INET6, IPV4 = AF_INET }
       enum Error { errSuccess = 0, errCreateFailed, errCopyFailed, errInput, errInputInterrupt,
           errResourceFailure, errOutput, errOutputInterrupt, errNotConnected, errConnectRefused,
           errConnectRejected, errConnectTimeout, errConnectFailed, errConnectInvalid, errConnectBusy,
           errConnectNoRoute, errBindingFailed, errBroadcastDenied, errRoutingDenied, errKeepaliveDenied,
           errServiceDenied, errServiceUnavailable, errMulticastDisabled, errTimeout, errNoDelay, errExtended,
           errLookupFail, errSearchErr, errInvalidValue }
       enum Tos { tosLowDelay = 0, tosThroughput, tosReliability, tosMinCost, tosInvalid }
       enum Pending { pendingInput, pendingOutput, pendingError }
       typedef enum FamilyFamily
       typedef enum ErrorError
       typedef enum TosTos
       typedef enum PendingPendingPublicMemberFunctions
       virtual ~Socket ()
           The socket base class may be 'thrown' as a result of an error, and the 'catcher' may then choose to
           destroy the object.
       Socket & operator= (const Socket &from)
           Sockets may also be duplicated by the assignment operator.
       virtual IPV4HostgetIPV4Sender (tpport_t *port=NULL) const
           May be used to examine the origin of data waiting in the socket receive queue.
       IPV4HostgetSender (tpport_t *port=NULL) const
       virtual IPV6HostgetIPV6Sender (tpport_t *port=NULL) const
       IPV4HostgetIPV4Peer (tpport_t *port=NULL) const
           Get the host address and port of the socket this socket is connected to.
       IPV4HostgetPeer (tpport_t *port=NULL) const
       IPV6HostgetIPV6Peer (tpport_t *port=NULL) const
       IPV4HostgetIPV4Local (tpport_t *port=NULL) const
           Get the local address and port number this socket is currently bound to.
       IPV4HostgetLocal (tpport_t *port=NULL) const
       IPV6HostgetIPV6Local (tpport_t *port=NULL) const
       IPV4HostgetIPV4NAT (tpport_t *port=NULL) const
           Perform NAT table lookup for this socket.
       IPV4HostgetNAT (tpport_t *port) const
       IPV6HostgetIPV6NAT (tpport_t *port=NULL) const
       void setCompletion (bool immediate)
           Used to specify blocking mode for the socket.
       ErrorsetLinger (bool linger)
           Enable lingering sockets on close.
       ErrorsetKeepAlive (bool enable)
           Set the keep-alive status of this socket and if keep-alive messages will be sent.
       ErrorsetTypeOfService (Tos service)
           Set packet scheduling on platforms which support ip quality of service conventions.
       bool isConnected (void) const
           Can test to see if this socket is 'connected', and hence whether a 'catch' can safely call getPeer().
       bool isActive (void) const
           Test to see if the socket is at least operating or if it is mearly initialized.
       bool operator! () const
           Operator based testing to see if a socket is currently active.
       bool isBroadcast (void) const
           Return if broadcast has been enabled for the specified socket.
       bool isRouted (void) const
           Return if socket routing is enabled.
       ErrorgetErrorNumber (void) const
           Often used by a 'catch' to fetch the last error of a thrown socket.
       const char * getErrorString (void) const
           Often used by a 'catch' to fetch the user set error string of a thrown socket, but only if EXTENDED
           error codes are used.
       long getSystemError (void) const
       const char * getSystemErrorString (void) const
       virtual bool isPending (Pending pend, timeout_t timeout=TIMEOUT_INF)
           Get the status of pending operations.

   StaticPublicMemberFunctions
       static bool check (Family fam)
           See if a specific protocol family is available in the current runtime environment.

   ProtectedTypes
       enum State { INITIAL, AVAILABLE, BOUND, CONNECTED, CONNECTING, STREAM }
       typedef enum StateStateProtectedMemberFunctionsErrorerror (Error error, const char *err=NULL, long systemError=0) const
           This service is used to throw all socket errors which usually occur during the socket constructor.
       void error (const char *err) const
           This service is used to throw application defined socket errors where the application specific error
           code is a string.
       void setError (bool enable)
           This service is used to turn the error handler on or off for 'throwing' exceptions by manipulating
           the thrown flag.
       void endSocket (void)
           Used as the default destructor for ending a socket.
       ErrorconnectError (void)
           Used as a common handler for connection failure processing.
       ErrorsendLimit (int limit=2048)
           Set the send limit.
       ErrorreceiveLimit (int limit=1)
           Set thr receive limit.
       ErrorsendTimeout (timeout_t timer)
           Set the send timeout for sending raw network data.
       ErrorreceiveTimeout (timeout_t timer)
           Receive timeout for receiving raw network data.
       ErrorsendBuffer (unsigned size)
           Set the protocol stack network kernel send buffer size associated with the socket.
       ErrorreceiveBuffer (unsigned size)
           Set the protocol stack network kernel receive buffer size associated with the socket.
       ErrorbufferSize (unsigned size)
           Set the total protocol stack network kernel buffer size for both send and receive together.
       ErrorsetBroadcast (bool enable)
           Set the subnet broadcast flag for the socket.
       ErrorsetMulticastByFamily (bool enable, Family family=IPV4)
           Setting multicast binds the multicast interface used for the socket to the interface the socket
           itself has been implicitly bound to.
       ErrorsetLoopbackByFamily (bool enable, Family family=IPV4)
           Set the multicast loopback flag for the socket.
       ErrorsetTimeToLiveByFamily (unsigned char ttl, Family fam=IPV4)
           Set the multicast time to live for a multicast socket.
       Errorjoin (const IPV4Multicast &ia)
           Join a multicast group.
       Errorjoin (const IPV6Multicast &ia)
       Errordrop (const IPV4Multicast &ia)
           Drop membership from a multicast group.
       Errordrop (const IPV6Multicast &ia)
       ErrorsetRouting (bool enable)
           Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
       ErrorsetNoDelay (bool enable)
           Enable/disable delaying packets (Nagle algorithm)
       Socket (int domain, int type, int protocol=0)
           An unconnected socket may be created directly on the local machine.
       Socket (SOCKET fd)
           A socket object may be created from a file descriptor when that descriptor was created either through
           a socket() or accept() call.
       Socket ()
           Create an inactive socket object for base constructors.
       Socket (const Socket &source)
           A socket can also be constructed from an already existing Socket object.
       ssize_t readLine (char *buf, size_t len, timeout_t timeout=0)
           Process a logical input line from a socket descriptor directly.
       virtual ssize_t readData (void *buf, size_t len, char separator=0, timeout_t t=0)
           Read in a block of len bytes with specific separator.
       virtual ssize_t writeData (const void *buf, size_t len, timeout_t t=0)
           Write a block of len bytes to socket.

   ProtectedAttributes
       struct {
          bool thrown: 1
          bool broadcast: 1
          bool route: 1
          bool keepalive: 1
          bool loopback: 1
          bool multicast: 1
          bool completion: 1
          bool linger: 1
          unsigned ttl: 8
       } flagsSOCKET volatile so
           the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that
           way madness lies -- jfc
       State volatile stateStaticProtectedAttributes
       static MutexmutexFriendsSOCKETdupSocket (SOCKET s, Socket::Statestate)