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/Endpoint.h"
00024 
00025 #include <cstdint>
00026 
00027 /**
00028 UDP Socket
00029 */
00030 class UDPSocket : public Socket {
00031 
00032 public:
00033     /** Instantiate an UDP Socket.
00034     */
00035     UDPSocket();
00036     
00037     /** Init the UDP Client Socket without binding it to any specific port
00038     \return 0 on success, -1 on failure.
00039     */
00040     int init(void);
00041     
00042     /** Bind a UDP Server Socket to a specific port
00043     \param port The port to listen for incoming connections on
00044     \return 0 on success, -1 on failure.
00045     */
00046     int bind(int port);
00047     
00048     /** Join the multicast group at the given address
00049     \param address  The address of the multicast group
00050     \return 0 on success, -1 on failure.
00051     */
00052     int join_multicast_group(const char* address);
00053     
00054     /** Set the socket in broadcasting mode
00055     \return 0 on success, -1 on failure.
00056     */
00057     int set_broadcasting(void);
00058     
00059     /** Send a packet to a remote endpoint
00060     \param remote   The remote endpoint
00061     \param packet   The packet to be sent
00062     \param length   The length of the packet to be sent
00063     \return the number of written bytes on success (>=0) or -1 on failure
00064     */
00065     int sendTo(Endpoint &remote, char *packet, int length);
00066     
00067     /** Receive a packet from a remote endpoint
00068     \param remote   The remote endpoint
00069     \param buffer   The buffer for storing the incoming packet data. If a packet
00070            is too long to fit in the supplied buffer, excess bytes are discarded
00071     \param length   The length of the buffer
00072     \return the number of received bytes on success (>=0) or -1 on failure
00073     */
00074     int receiveFrom(Endpoint &remote, char *buffer, int length);
00075 };
00076 
00077 #endif