simple-socket library 1.1.5
Public Types | Public Member Functions | Protected Types | Static Protected Member Functions | Protected Attributes

NET::TCPSocket Class Reference

TCP socket class. More...

#include <TCPSocket.h>

List of all members.

Public Types

typedef SocketHandle< TCPSocketHandle
 Handle for a new socket returned by accept.
enum  ShutdownDirection { STOP_SEND = SHUT_WR, STOP_RECEIVE = SHUT_RD, STOP_BOTH = SHUT_RDWR }

Public Member Functions

Handle accept () const
 wait for another socket to connect
void bind (unsigned short localPort=0)
void bind (const std::string &localAddress, unsigned short localPort=0)
 bind socket to address / port
void connect (const std::string &foreignAddress, unsigned short foreignPort)
 establish a connection with the given foreign address and port
void disconnect ()
std::string getForeignAddress () const
unsigned short getForeignPort () const
std::string getLocalAddress () const
unsigned short getLocalPort () const
void listen (int backlog=5)
 listen for incoming connections
bool peerDisconnected () const
 returns whether a peer disconnected
int receive (void *buffer, size_t len)
 receive data from a bound socket
int send (const void *buffer, size_t len)
 send data through a connected socket
int sendAll (const void *buffer, size_t len)
 send data through a connected socket
void shutdown (ShutdownDirection type)
 shutdown the connection in the specified direction
 TCPSocket (Handle handle)
 TCPSocket ()
Handle timedAccept (int timeout) const
 wait for another socket to connect
int timedReceive (void *buffer, size_t len, int timeout)
 receive data from a bound socket, return after the given timespan

Protected Types

enum  SocketDomain { INTERNET = PF_INET, UNIX = PF_LOCAL }
enum  SocketType { STREAM = SOCK_STREAM, DATAGRAM = SOCK_DGRAM }

Static Protected Member Functions

static void fillAddress (const std::string &address, unsigned short port, sockaddr_in &addr)

Protected Attributes

bool m_peerDisconnected
int m_socket

Detailed Description

TCP socket class.

Examples:

TCP_Client.cpp, and TCP_Server.cpp.

Definition at line 10 of file TCPSocket.h.


Member Typedef Documentation

Handle for a new socket returned by accept.

Definition at line 14 of file TCPSocket.h.


Member Enumeration Documentation

Enumerator:
STOP_SEND 

disable all variants of send() on the socket, receive calls still work

STOP_RECEIVE 

disable all variants of receive() on the socket, send calls still work

STOP_BOTH 

disable all send() and receive() calls on the socket

Definition at line 49 of file SimpleSocket.h.

enum NET::SimpleSocket::SocketDomain [protected, inherited]
Enumerator:
INTERNET 
UNIX 

Definition at line 166 of file SimpleSocket.h.

enum NET::SimpleSocket::SocketType [protected, inherited]
Enumerator:
STREAM 
DATAGRAM 

Definition at line 172 of file SimpleSocket.h.


Constructor & Destructor Documentation

TCPSocket::TCPSocket ( )

Construct a TCP socket

Exceptions:
SocketExceptionthrown if unable to create the socket

Definition at line 10 of file TCPSocket.cpp.

TCPSocket::TCPSocket ( Handle  handle)

Construct a Socket from a Handle returned by accept()

Exceptions:
SocketExceptionthrown if handle is invalid

Definition at line 14 of file TCPSocket.cpp.


Member Function Documentation

int TCPSocket::sendAll ( const void *  buffer,
size_t  len 
)

send data through a connected socket

sendAll() can only be used on a socket that called connect() before. If you try to use sendAll() on a unconnected socket, a SocketException will be thrown.

When using a stream oriented socket, the operating system is allowed to send only a bit of the data you requested it to send. Because of this, you would have to check the number of sent bytes when using send(), and resend unsent data manually. sendAll() takes that responsibility from you and resends as long as it needs, to completely send the data given to it.

Parameters:
bufferdata to be send
lenlength of the data to be sent
Returns:
number of bytes sent
Exceptions:
SocketException

Definition at line 18 of file TCPSocket.cpp.

void TCPSocket::listen ( int  backlog = 5)

listen for incoming connections

listen() can be called on a bound socket. The socket will then go into a passive state and accept incoming connections. To answer to an incoming connection call accept() or timedAccept() on the socket.

The backlog is a buffer for incoming connections. If backlog is set to 0, the number of incoming connections is only limited by the operating system. If backlog is set to a value > 0, only the upper limit of connections is set, the OS can limit the number further.

After starting to listen, use accept to accept incoming connections.

Parameters:
backlogupper limit of pending incoming connections
Exceptions:
SocketException
Examples:
TCP_Server.cpp.

Definition at line 31 of file TCPSocket.cpp.

TCPSocket::Handle TCPSocket::accept ( ) const

wait for another socket to connect

accept() will block until a new connection arrives. It is used to create TCP server applications. On return it will return the handle to the incoming connection.

accept can be only called on a listening socket.

Use the returned handle to create a new TCPSocket to communicate with the new connected client. Regardless of what you do with a handle, accept() can be used to wait for next incoming connection after the handle was received.

Returns:
SocketHandle object to the new connection
Exceptions:
SocketException

Definition at line 38 of file TCPSocket.cpp.

TCPSocket::Handle TCPSocket::timedAccept ( int  timeout) const

wait for another socket to connect

timedAccept() will block until a new connection arrives, or the given timeout runs out. It is used to create TCP server applications. On return it will return the handle to the incoming connection.

This handle might be invalid, so it should be checked before it is used. Creating a new socket object using an invalid handle will raise an exception.

timedAccept() can only be called on a listening socket.

Use the returned handle to create a new TCPSocket to communicate with the new connected client. Regardless of what you do with a handle, timedAccept() can be used to wait for next incoming connection after the handle was returned.

Parameters:
timeoutthe timeout in ms after which accept will give up and return
Returns:
Handle object to the new connection
Exceptions:
SocketException
Examples:
TCP_Server.cpp.

Definition at line 46 of file TCPSocket.cpp.

void InternetSocket::connect ( const std::string &  foreignAddress,
unsigned short  foreignPort 
) [inherited]

establish a connection with the given foreign address and port

If you are using a connection oriented socket (like TCPSocket), you have to call connect() on that socket in order to send data. However, if you are using a non-connection oriented socket (like UDPSocket), calling connect on that socket will allow you to use the send() function like on a connection oriented socket.

Parameters:
foreignAddressforeign address (IP address or name)
foreignPortforeign port
Exceptions:
SocketExceptionthrown if unable to establish connection
Examples:
TCP_Client.cpp, and UDP_Multicast.cpp.

Definition at line 19 of file InternetSocket.cpp.

void InternetSocket::bind ( unsigned short  localPort = 0) [inherited]

This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts. Instead of the richer function with more arguments, this bind() binds to any available interface / address

Examples:
TCP_Server.cpp, and UDP_Multicast.cpp.

Definition at line 30 of file InternetSocket.cpp.

void InternetSocket::bind ( const std::string &  localAddress,
unsigned short  localPort = 0 
) [inherited]

bind socket to address / port

Set the local port to the specified port and the local address to an interface.

bind() attaches the local endpoint of the socket to the specified interface and port. Typically all servers use bind() to attach to the local port specified by the used protocol. You just need to call bind if you want to restrict the connection to a specific local interface, or if you want to listen on a specific port. If you are just a client using connect() to connect to a server, calling bind is most likely unnecessary.

To bind to a port < 1023 you need eighter superuser access, or the SUID bit set on your program.

Parameters:
localAddresslocal address
localPortlocal port
Exceptions:
SocketExceptionthrown if setting local port fails

Definition at line 41 of file InternetSocket.cpp.

std::string InternetSocket::getLocalAddress ( ) const [inherited]

Get the local address (after binding the socket).

Returns:
local address of socket
Exceptions:
SocketExceptionthrown if fetch fails

Definition at line 50 of file InternetSocket.cpp.

unsigned short InternetSocket::getLocalPort ( ) const [inherited]

Get the local port (after binding the socket).

Returns:
local port of socket
Exceptions:
SocketExceptionthrown if fetch fails

Definition at line 61 of file InternetSocket.cpp.

std::string InternetSocket::getForeignAddress ( ) const [inherited]

Get the foreign address. Call connect() before using this function.

Returns:
foreign address
Exceptions:
SocketExceptionthrown if unable to fetch foreign address

Definition at line 72 of file InternetSocket.cpp.

unsigned short InternetSocket::getForeignPort ( ) const [inherited]

Get the foreign port. Call connect() before using this function.

Returns:
foreign port
Exceptions:
SocketExceptionthrown if unable to fetch foreign port

Definition at line 83 of file InternetSocket.cpp.

void InternetSocket::fillAddress ( const std::string &  address,
unsigned short  port,
sockaddr_in &  addr 
) [static, protected, inherited]

Fill an address structure with the given address and port number. If the given address is not a valid IPv4 address, it will be resolved by hostname or DNS lookup. addr will be unchanged if this resolve fails.

Parameters:
addressIPv4 domain name or address
portIP port number to fill in
addraddress structure to fill
Exceptions:
SocketExceptionthrown if unable to resolve a hostname

Definition at line 94 of file InternetSocket.cpp.

int SimpleSocket::send ( const void *  buffer,
size_t  len 
) [inherited]

send data through a connected socket

send() can only be used on a socket that called connect() before. If you try to use send() on a not connected socket, SocketException will be thrown.

If you are using a stream oriented socket (like TCPSocket), the operating system is allowed to send only a part of the packet you told it to send, so send() will return the number of bytes actually sent. It is your responsibility to resend the data not sent by send()

If you are using a datagram oriented socket (like UDPSocket or SCTPSocket) the operating system will only send and receive complete datagrams, but send() will fail if you are trying to send too much data. In that case SocketException will be thrown.

Parameters:
bufferdata to be send
lenlength of the data to be sent
Returns:
number of bytes sent
Exceptions:
SocketExceptionif sending went wrong
Examples:
TCP_Server.cpp, and UDP_Multicast.cpp.

Definition at line 43 of file SimpleSocket.cpp.

int SimpleSocket::receive ( void *  buffer,
size_t  len 
) [inherited]

receive data from a bound socket

receive() can only be used on a socket that called bind() or connect() before. If you try to use receive() on a not bound socket, SocketException will be thrown.

If using a stream oriented Socket, receive can return a part of a received messge, e.g. if you send 100 bytes, it's possible you will receive 50 bytes two times in a row. However, the order of the sent data will be preserved.

If you are using a datagram oriented sockets, you will only receive whole datagrams. But beware of using a too small buffer. If the receive buffer is too small for the received datagram, the data you didn't read in the receive call will be discared.

If the remote host has closed the connection (on a connection based socket like TCP or SCTP) receive() will return 0. If you are using a connectionless protocol (like UDP) there is no way to determine wheter the connection has been closed by the remote host or not.

Parameters:
bufferthe buffer the received data will be written to
lenlength of the provided buffer, receive will not read more than that
Returns:
number of bytes received
Exceptions:
SocketExceptionin case an error occured
Examples:
UDP_Multicast.cpp.

Definition at line 61 of file SimpleSocket.cpp.

int SimpleSocket::timedReceive ( void *  buffer,
size_t  len,
int  timeout 
) [inherited]

receive data from a bound socket, return after the given timespan

timedReceive() can only be used on a socket that called bind() or connect before. If you try to use receive() on a not bound socket, SocketException will be thrown.

If using a stream oriented Socket, receive can return a part of a received messge, e.g. if you send 100 bytes, it's possible you will receive 50 bytes two times in a row. However, the order of the sent data will be preserved.

If you are using a datagram oriented sockets, you will only receive whole datagrams. But beware of using a too small buffer. If the receive buffer is too small for the received datagram, the data you didn't read in the receive call will be discared.

If the remote host has closed the connection (on a connection based socket like TCP or SCTP) receive() will return 0. If you are using a connectionless protocol (like UDP) there is no way to determine wheter the connection has been closed by the remote host or not.

Parameters:
bufferthe buffer the received data will be written to
lenlength of the provided buffer, receive will not read more than that
timeoutthe timeout in ms after which receive will give up and return
Returns:
number of bytes received, 0 on timeout
Exceptions:
SocketExceptionin case an error occured
Examples:
TCP_Client.cpp.

Definition at line 68 of file SimpleSocket.cpp.

void SimpleSocket::disconnect ( ) [inherited]

Disconnect and unset any foreign addresses

Exceptions:
SocketExceptionthrown if unable to disconnect
Examples:
TCP_Client.cpp, and TCP_Server.cpp.

Definition at line 88 of file SimpleSocket.cpp.

void SimpleSocket::shutdown ( ShutdownDirection  type) [inherited]

shutdown the connection in the specified direction

Depending on the specified ShutdownDirection, calls for that direction will stop working. Use this function if you want to have more control than just destroing the socket. It allows you to cut the connection in one direction, or both.

If you use shutdown() on an unconnected socket, the corresponding calls will simply stop working.

Parameters:
typethe ShutdownDirection that be used
Exceptions:
SocketExceptionin case an error occured

Definition at line 103 of file SimpleSocket.cpp.

bool SimpleSocket::peerDisconnected ( ) const [inherited]

returns whether a peer disconnected

Will only work if you use a connection oriented, connected socket. Returns true if the peer disconnected. Use this function after a call to receive, returned 0 received bytes.

Returns:
true if a peer disconnected
Examples:
TCP_Server.cpp.

Definition at line 109 of file SimpleSocket.cpp.


Member Data Documentation

int NET::SimpleSocket::m_socket [protected, inherited]

Definition at line 185 of file SimpleSocket.h.

bool NET::SimpleSocket::m_peerDisconnected [protected, inherited]

Definition at line 186 of file SimpleSocket.h.


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