SocketGUS
Fork of Socket by
Diff: UDPSocket.h
- Revision:
- 0:1f77255a22f5
- Child:
- 1:8080965f5d76
diff -r 000000000000 -r 1f77255a22f5 UDPSocket.h --- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/UDPSocket.h Tue Jun 26 13:16:26 2012 +0000 @@ -0,0 +1,75 @@ +/* Copyright (C) 2012 mbed.org, MIT License + * + * Permission is hereby granted, free of charge, to any person obtaining a copy of this software + * and associated documentation files (the "Software"), to deal in the Software without restriction, + * including without limitation the rights to use, copy, modify, merge, publish, distribute, + * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is + * furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in all copies or + * substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING + * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND + * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, + * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, + * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + */ + +#ifndef UDPSOCKET_H +#define UDPSOCKET_H + +#include <cstdint> + +/** +This is a C++ abstraction for UDP networking sockets. +*/ +class UDPSocket +{ + public: + + /** Instantiate a UDP Socket. + */ + UDPSocket(); + + ~UDPSocket(); + + /** Bind a socket to a specific port. + For a listening socket, bind the socket to the following port. + \param port The port to listen for incoming connections on, using 0 here will select a random port. + \return 0 on success, -1 on failure. + */ + int bind(int port); + + /** Send data to a remote host. + \param data The buffer to send to the host. + \param length The length of the buffer to send. + \param host The host to send data to. It can either be an IP Address or a hostname that will be resolved with DNS. + \param port The host's port to send data to. + \param timeout The maximum amount of time in ms to wait while trying to send the buffer. + \return the number of written bytes on success (>=0) or -1 on failure + */ + int sendTo(std::uint8_t* data, int length, char* host, int port, int timeout = 0); + + /** Receive data from a remote host. + \param data The buffer in which to store the data received from the host. + \param length The maximum length of the buffer. + \param host The reference that will point to the client's IP address. + \param port The reference that will point to the client's port. + \param timeout The maximum amount of time in ms to wait while trying to receive data. + \return the number of received bytes on success (>=0) or -1 on failure + */ + int receiveFrom(std::uint8_t* data, int length, char** host, int* port, int timeout = 0); + + /** Close the socket. + */ + int close(); + + private: + int init(); + + int m_sock; + +}; + +#endif