diff options
Diffstat (limited to 'osframework/source/SexyAppFramework/SexySocket.h')
| -rw-r--r-- | osframework/source/SexyAppFramework/SexySocket.h | 270 |
1 files changed, 270 insertions, 0 deletions
diff --git a/osframework/source/SexyAppFramework/SexySocket.h b/osframework/source/SexyAppFramework/SexySocket.h new file mode 100644 index 0000000..de13449 --- /dev/null +++ b/osframework/source/SexyAppFramework/SexySocket.h @@ -0,0 +1,270 @@ +#ifndef __SEXY_SOCKET_H__ +#define __SEXY_SOCKET_H__ + +#include <string> // For string + +using namespace std; + +namespace Sexy { + +/** + * Base class representing basic communication endpoint + */ + class Socket { + public: + /** + * Close and deallocate this socket + */ + ~Socket(); + + /** + * Check the socket whether is in error state + * @return true if the socket is in error state + */ + bool hasError(); + + /** + * Get the local address + * @return local address of socket + */ + string getLocalAddress(); + + /** + * Get the local port + * @return local port of socket + */ + unsigned getLocalPort(); + + /** + * Set the local port to the specified port and the local address + * to any interface + * @param localPort local port + */ + bool setLocalPort(unsigned short localPort); + + /** + * Set the local port to the specified port and the local address + * to the specified address. If you omit the port, a random port + * will be selected. + * @param localAddress local address + * @param localPort local port + */ + bool setLocalAddressAndPort(const string &localAddress, + unsigned short localPort = 0); + + /** + * If WinSock, unload the WinSock DLLs; otherwise do nothing. We ignore + * this in our sample client code but include it in the library for + * completeness. If you are running on Windows and you are concerned + * about DLL resource consumption, call this after you are done with all + * Socket instances. If you execute this on Windows while some instance of + * Socket exists, you are toast. For portability of client code, this is + * an empty function on non-Windows platforms so you can always include it. + */ + static void cleanup(); + + /** + * Resolve the specified service for the specified protocol to the + * corresponding port number in host byte order + * @param service service to resolve (e.g., "http") + * @param protocol protocol of service to resolve. Default is "tcp". + */ + static unsigned short resolveService(const string &service, + const string &protocol = "tcp"); + + private: + // Prevent the user from trying to use value semantics on this object + Socket(const Socket &sock); + void operator=(const Socket &sock); + + protected: + int mSock; // Socket descriptor + bool mHasError; + Socket(int type, int protocol); + Socket(int sock); + }; + + /** + * Socket which is able to connect, send, and receive + */ + class CommunicatingSocket : public Socket { + public: + /** + * Establish a socket connection with the given foreign + * address and port + * @param foreignAddress foreign address (IP address or name) + * @param foreignPort foreign port + */ + bool connect(const string &foreignAddress, unsigned short foreignPort); + + /** + * Write the given buffer to this socket. Call connect() before + * calling send() + * @param buffer buffer to be written + * @param bufferLen number of bytes from buffer to be written + */ + bool send(const void *buffer, int bufferLen); + + /** + * Read into the given buffer up to bufferLen bytes data from this + * socket. Call connect() before calling recv() + * @param buffer buffer to receive the data + * @param bufferLen maximum number of bytes to read into buffer + * @return number of bytes read, 0 for EOF, and -1 for error + */ + int recv(void *buffer, int bufferLen); + + /** + * Get the foreign address. Call connect() before calling recv() + * @return foreign address + */ + string getForeignAddress(); + + /** + * Get the foreign port. Call connect() before calling recv() + * @return foreign port + */ + unsigned getForeignPort(); + + protected: + CommunicatingSocket(int type, int protocol); + CommunicatingSocket(int newConnSD); + }; + + /** + * TCP socket for communication with other TCP sockets + */ + class TCPSocket : public CommunicatingSocket { + public: + /** + * Construct a TCP socket with no connection + */ + TCPSocket(); + + /** + * Construct a TCP socket with a connection to the given foreign address + * and port + * @param foreignAddress foreign address (IP address or name) + * @param foreignPort foreign port + */ + TCPSocket(const string &foreignAddress, unsigned short foreignPort); + + private: + // Access for TCPServerSocket::accept() connection creation + friend class TCPServerSocket; + TCPSocket(int newConnSD); + }; + + /** + * TCP socket class for servers + */ + class TCPServerSocket : public Socket { + public: + /** + * Construct a TCP socket for use with a server, accepting connections + * on the specified port on any interface + * @param localPort local port of server socket, a value of zero will + * give a system-assigned unused port + * @param queueLen maximum queue length for outstanding + * connection requests (default 5) + */ + TCPServerSocket(unsigned short localPort, int queueLen = 5); + + /** + * Construct a TCP socket for use with a server, accepting connections + * on the specified port on the interface specified by the given address + * @param localAddress local interface (address) of server socket + * @param localPort local port of server socket + * @param queueLen maximum queue length for outstanding + * connection requests (default 5) + */ + TCPServerSocket(const string &localAddress, unsigned short localPort, + int queueLen = 5); + + /** + * Blocks until a new connection is established on this socket or error + * @return new connection socket + */ + TCPSocket *accept(); + + private: + bool setListen(int queueLen); + }; + + /** + * UDP socket class + */ + class UDPSocket : public CommunicatingSocket { + public: + /** + * Construct a UDP socket + */ + UDPSocket(); + + /** + * Construct a UDP socket with the given local port + * @param localPort local port + */ + UDPSocket(unsigned short localPort); + + /** + * Construct a UDP socket with the given local port and address + * @param localAddress local address + * @param localPort local port + */ + UDPSocket(const string &localAddress, unsigned short localPort); + + /** + * Unset foreign address and port + * @return true if disassociation is successful + */ + bool disconnect(); + + /** + * Send the given buffer as a UDP datagram to the + * specified address/port + * @param buffer buffer to be written + * @param bufferLen number of bytes to write + * @param foreignAddress address (IP address or name) to send to + * @param foreignPort port number to send to + * @return true if send is successful + */ + bool sendTo(const void *buffer, int bufferLen, const string &foreignAddress, + unsigned short foreignPort); + + /** + * Read read up to bufferLen bytes data from this socket. The given buffer + * is where the data will be placed + * @param buffer buffer to receive data + * @param bufferLen maximum number of bytes to receive + * @param sourceAddress address of datagram source + * @param sourcePort port of data source + * @return number of bytes received and -1 for error + */ + int recvFrom(void *buffer, int bufferLen, string &sourceAddress, + unsigned short &sourcePort); + + /** + * Set the multicast TTL + * @param multicastTTL multicast TTL + */ + bool setMulticastTTL(unsigned char multicastTTL); + + /** + * Join the specified multicast group + * @param multicastGroup multicast group address to join + */ + bool joinGroup(const string &multicastGroup); + + /** + * Leave the specified multicast group + * @param multicastGroup multicast group address to leave + */ + bool leaveGroup(const string &multicastGroup); + + private: + void setBroadcast(); + }; + +} +#endif |