UDPSocket.h

00001 /* Copyright (C) 2012 mbed.org, MIT License
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  */
00018 
00019 #ifndef UDPSOCKET_H
00020 #define UDPSOCKET_H
00021 
00022 #include "Socket/Socket.h"
00023 #include "Socket/UDPPacket.h"
00024 #include <cstdint>
00025 
00026 /**
00027 This is a C++ abstraction for UDP networking sockets.
00028 */
00029 class UDPSocket : public Socket {
00030 
00031 public:
00032     /** Instantiate a UDP Socket.
00033     */
00034     UDPSocket();
00035     
00036     ~UDPSocket();
00037     
00038     int init(void);
00039     
00040     /** Bind a UDP Server Socket to a specific port
00041     For a listening socket, bind the socket to the following port.
00042     \param port The port to listen for incoming connections on, using 0 here will select a random port.
00043     \return 0 on success, -1 on failure.
00044     */
00045     int bind(int port);
00046     
00047     /** Send a packet to the remote host.
00048     \param packet UDP Packet to be sent to the remote host
00049     \param timeout The maximum amount of time in ms to wait while trying to send the buffer.
00050     \return the number of written bytes on success (>=0) or -1 on failure
00051     */
00052     int sendTo(UDPPacket& packet, int timeout_ms=0);
00053     
00054     /** Receive data from a remote host.
00055     If a message is too long to fit in the supplied packet, excess bytes are
00056     discarded.
00057     \param packet UDP Packet received from the remote host
00058     \param timeout The maximum amount of time in ms to wait while trying to receive data.
00059     \return the number of received bytes on success (>=0) or -1 on failure
00060     */
00061     int receiveFrom(UDPPacket& packet, int timeout_ms=0);
00062 };
00063 
00064 #endif