The Socket is used as the base for all Internet protocol services under Common C++.
More...
#include <socket.h>
Inheritance diagram for Socket:
Collaboration diagram for Socket:
Public Types
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
}
Public Member Functions
The socket base class may be "thrown" as a result of an error, and the "catcher" may then choose to destroy the object.
More...
Sockets may also be duplicated by the assignment operator.
More...
May be used to examine the origin of data waiting in the socket receive queue.
More...
Get the host address and port of the socket this socket is connected to.
More...
Get the local address and port number this socket is currently bound to.
More...
Perform NAT table lookup for this socket.
More...
Used to specify blocking mode for the socket.
More...
Enable lingering sockets on close.
More...
Set the keep-alive status of this socket and if keep-alive messages will be sent.
More...
Set packet scheduling on platforms which support ip quality of service conventions.
More...
Can test to see if this socket is "connected", and hence whether a "catch" can safely call
getPeer().
More...
Test to see if the socket is at least operating or if it is mearly initialized.
More...
Operator based testing to see if a socket is currently active.
More...
Return if broadcast has been enabled for the specified socket.
More...
Return if socket routing is enabled.
More...
Often used by a "catch" to fetch the last error of a thrown socket.
More...
Often used by a "catch" to fetch the user set error string of a thrown socket, but only if EXTENDED error codes are used.
More...
Get the status of pending operations.
More...
Static Public Member Functions
See if a specific protocol family is available in the current runtime environment.
More...
Protected Types
Protected Member Functions
This service is used to throw all socket errors which usually occur during the socket constructor.
More...
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.
More...
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
More...
Used as the default destructor for ending a socket.
More...
Used as a common handler for connection failure processing.
More...
Set the send timeout for sending raw network data.
More...
Receive timeout for receiving raw network data.
More...
Set the protocol stack network kernel send buffer size associated with the socket.
More...
Set the protocol stack network kernel receive buffer size associated with the socket.
More...
Set the total protocol stack network kernel buffer size for both send and receive together.
More...
Set the subnet broadcast flag for the socket.
More...
Setting multicast binds the multicast interface used for the socket to the interface the socket itself has been implicitly bound to.
More...
Set the multicast loopback flag for the socket.
More...
Set the multicast time to live for a multicast socket.
More...
Drop membership from a multicast group.
More...
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
More...
Enable/disable delaying packets (Nagle algorithm)
More...
Socket (int domain, int type, int protocol=0)
An unconnected socket may be created directly on the local machine.
More...
A socket object may be created from a file descriptor when that descriptor was created either through a socket() or accept() call.
More...
Create an inactive socket object for base constructors.
More...
A socket can also be constructed from an already existing
Socket object.
More...
Process a logical input line from a socket descriptor directly.
More...
Read in a block of len bytes with specific separator.
More...
Write a block of len bytes to socket.
More...
Protected Attributes
struct {
the actual socket descriptor, in Windows, unlike posix it
cannot be used as an file descriptor that way madness lies – jfc
More...
Static Protected Attributes
Private Member Functions
Private Attributes
Friends
Detailed Description
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.nosp@m.@ost.nosp@m.el.co.nosp@m.m base class of all sockets.
Definition at line 119 of file socket.h.
Member Typedef Documentation
Member Enumeration Documentation
| Enumerator |
|---|
| errSuccess |
| 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 |
Definition at line 131 of file socket.h.
| Enumerator |
|---|
| pendingInput |
| pendingOutput |
| pendingError |
Definition at line 174 of file socket.h.
| Enumerator |
|---|
| INITIAL |
| AVAILABLE |
| BOUND |
| CONNECTED |
| CONNECTING |
| STREAM |
Definition at line 182 of file socket.h.
| Enumerator |
|---|
| tosLowDelay |
| tosThroughput |
| tosReliability |
| tosMinCost |
| tosInvalid |
Definition at line 165 of file socket.h.
Constructor & Destructor Documentation
Socket::Socket
(
int
domain,
int
type,
int
protocol = 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.
- Parameters
-
domain socket domain to use.
type base type and protocol family of the socket.
protocol specific protocol to apply.
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.
- Parameters
-
fd file descriptor of an already existing socket.
Socket::Socket
(
)
protected |
Create an inactive socket object for base constructors.
Socket::Socket
(
const
Socket &
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.
- Parameters
-
source of existing socket to clone.
virtual 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.
Member Function Documentation
Error Socket::bufferSize
(
unsigned
size )
protected |
Set the total protocol stack network kernel buffer size for both send and receive together.
- Returns
- errSuccess on success
- Parameters
-
size of buffer.
static bool Socket::check
(
Family
fam )
static |
See if a specific protocol family is available in the current runtime environment.
- Returns
- true if family available.
Error Socket::connectError
(
void
)
protected |
Used as a common handler for connection failure processing.
- Returns
- correct failure code to apply.
Drop membership from a multicast group.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ia address of multicast group to drop.
void 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.
const char *
err = NULL,
long
systemError = 0
)
const
protected |
This service is used to throw all socket errors which usually occur during the socket constructor.
- Parameters
-
error defined socket error id.
err string or message to pass.
systemError the system error# that caused the error
void Socket::error
(
const char *
err )
const
inlineprotected |
This service is used to throw application defined socket errors where the application specific error code is a string.
- Parameters
-
err string or message to pass.
Definition at line 240 of file socket.h.
Error 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.
Definition at line 668 of file socket.h.
const char* 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.
Definition at line 676 of file socket.h.
Get the local address and port number this socket is currently bound to.
- Parameters
-
port ptr to port number on local host.
- Returns
- host address of interface this socket is bound to.
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).
- Parameters
-
port ptr to NATed port number on local host.
- Returns
- NATed host address that this socket is related to.
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.
- Parameters
-
port ptr to port number of remote socket.
- Returns
- host address of remote socket.
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.
- Parameters
-
port ptr to port number of sender.
- Returns
- host address, test with "isInetAddress()".
Reimplemented in DCCPSocket.
long Socket::getSystemError
(
void
)
const
inline |
const char* Socket::getSystemErrorString
(
void
)
const
bool 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.
bool Socket::isBroadcast
(
void
)
const
inline |
Return if broadcast has been enabled for the specified socket.
- Returns
- true if broadcast socket.
Definition at line 651 of file socket.h.
bool 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.
virtual bool Socket::isPending
(
Pending
pend,
)
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.
- Parameters
-
pend ready check to perform.
timeout in milliseconds, inf. if not specified.
Reimplemented in SimpleTCPStream, TCPStream, and UnixStream.
bool Socket::isRouted
(
void
)
const
inline |
Return if socket routing is enabled.
- Returns
- true if routing enabled.
Definition at line 659 of file socket.h.
Join a multicast group.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ia address of multicast group to join.
bool Socket::operator!
(
)
const
Operator based testing to see if a socket is currently active.
Sockets may also be duplicated by the assignment operator.
virtual ssize_t Socket::readData
(
void *
buf,
size_t
len,
char
separator = 0,
)
protectedvirtual |
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.
- Parameters
-
buf 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.
ssize_t Socket::readLine
(
char *
buf,
size_t
len,
)
protected |
Process a logical input line from a socket descriptor directly.
- Parameters
-
buf pointer to string.
len maximum length to read.
timeout for pending data in milliseconds.
- Returns
- number of bytes actually read.
Error Socket::receiveBuffer
(
unsigned
size )
protected |
Set the protocol stack network kernel receive buffer size associated with the socket.
- Returns
- errSuccess on success, or error.
- Parameters
-
size of buffer in bytes.
Error Socket::receiveLimit
(
int
limit =
1 )
protected |
Receive timeout for receiving raw network data.
- Returns
- errSuccess if set.
- Parameters
-
timer value in milliseconds.
Error Socket::sendBuffer
(
unsigned
size )
protected |
Set the protocol stack network kernel send buffer size associated with the socket.
- Returns
- errSuccess on success, or error.
- Parameters
-
size of buffer in bytes.
Error Socket::sendLimit
(
int
limit =
2048 )
protected |
Set the send timeout for sending raw network data.
- Returns
- errSuccess if set.
- Parameters
-
timer value in millisec.
Error Socket::setBroadcast
(
bool
enable )
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.
- Parameters
-
enable when set to true.
void Socket::setCompletion
(
bool
immediate )
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.
- Parameters
-
immediate mode specify socket I/O call blocking mode.
void Socket::setError
(
bool
enable )
inlineprotected |
This service is used to turn the error handler on or off for "throwing" exceptions by manipulating the thrown flag.
- Parameters
-
enable true to enable handler.
Definition at line 249 of file socket.h.
Error Socket::setKeepAlive
(
bool
enable )
Set the keep-alive status of this socket and if keep-alive messages will be sent.
- Returns
- 0 on success.
- Parameters
-
enable keep alive messages.
Error Socket::setLinger
(
bool
linger )
Enable lingering sockets on close.
- Parameters
-
linger specify linger enable.
Error Socket::setLoopbackByFamily
(
bool
enable,
)
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.
- Parameters
-
enable when set to true.
family of protocol.
Error Socket::setMulticastByFamily
(
bool
enable,
)
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.
- Parameters
-
enable when set to true.
family of protocol.
Error Socket::setNoDelay
(
bool
enable )
protected |
Enable/disable delaying packets (Nagle algorithm)
- Returns
- 0 on success.
- Parameters
-
enable disable Nagle algorithm when set to true.
Error Socket::setRouting
(
bool
enable )
protected |
Set the socket routing to indicate if outgoing messages should bypass normal routing (set false).
- Returns
- 0 on success.
- Parameters
-
enable normal routing when set to true.
void Socket::setSocket
(
void
)
private |
Error Socket::setTimeToLiveByFamily
(
unsigned char
ttl,
)
protected |
Set the multicast time to live for a multicast socket.
- Returns
- 0 (errSuccess) on success, else error code.
- Parameters
-
ttl time to live.
fam family of protocol.
Error Socket::setTypeOfService
(
Tos
service )
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.
- Parameters
-
service type of service enumerated type.
virtual ssize_t Socket::writeData
(
const void *
buf,
size_t
len,
)
protectedvirtual |
Write a block of len bytes to socket.
- Parameters
-
buf pointer to byte allocation.
len maximum length to write.
t timeout for pending data in milliseconds.
- Returns
- number of bytes actually written.
Friends And Related Function Documentation
Field Documentation
const char* Socket::errstr
mutableprivate |
struct { ... } Socket::flags
the actual socket descriptor, in Windows, unlike posix it cannot be used as an file descriptor that way madness lies – jfc
Definition at line 221 of file socket.h.
State volatile Socket::state
protected |
long Socket::syserr
mutableprivate |
The documentation for this class was generated from the following file:
Generated on Dec 21, 2017 for
commoncpp2-1.8.1,
ccrtp-1.7.2,
libzrtpcpp-2.3.4,
ccscript3-1.1.7,
ccaudio2-1.0.0 and
bayonne2-2.3.2
(after installation in /usr/local/)
by
doxygen 1.8.6