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  * Changes relative to mbed official version and others as identified
00019  * in the thread http://mbed.org/forum/team-165-components-community/topic/4844/?page=1#comment-24108
00020  * UDPSocket:
00021  * @li improve documentation
00022  * @li revise timeout on store command from default to 5000 msec
00023  * @li derived from 4:0bcec6272784
00024  */
00025 
00026 #ifndef UDPSOCKET_H
00027 #define UDPSOCKET_H
00028 
00029 #include "Endpoint.h"
00030 #include "Socket.h"
00031 
00032 #include <cstdint>
00033 
00034 /**
00035 UDP Socket
00036 */
00037 class UDPSocket: public Socket {
00038 
00039 public:
00040     /** Instantiate an UDP Socket.
00041     */
00042     UDPSocket();
00043     
00044     /** Init the UDP Client Socket without binding it to any specific port
00045     @return 0 on success, -1 on failure.
00046     */
00047     int init(void);
00048     
00049     /** Bind a UDP Server Socket to a specific port
00050     @param port The port to listen for incoming connections on
00051     @return 0 on success, -1 on failure.
00052     */
00053     int bind(int port = -1);
00054     
00055     /** Join the multicast group at the given address
00056     *param address  The address of the multicast group
00057     *return 0 on success, -1 on failure.
00058     */
00059     int join_multicast_group(const char* address);
00060     
00061     /** Set the socket in broadcasting mode
00062     \return 0 on success, -1 on failure.
00063     */
00064     int set_broadcasting(bool broadcast=true);
00065     
00066     /** Send a packet to a remote endpoint
00067     @param remote   The remote endpoint
00068     @param packet   The packet to be sent
00069     @param length   The length of the packet to be sent
00070     @return the number of written bytes on success (>=0) or -1 on failure
00071     */
00072     int sendTo(Endpoint &remote, char *packet, int length);
00073     
00074     /** Receive a packet from a remote endpoint
00075     @param remote   The remote endpoint
00076     @param buffer   The buffer for storing the incoming packet data. If a packet
00077            is too long to fit in the supplied buffer, excess bytes are discarded
00078     @param length   The length of the buffer
00079     @return the number of received bytes on success (>=0) or -1 on failure
00080     */
00081     int receiveFrom(Endpoint &remote, char *buffer, int length);
00082     
00083 private:
00084     bool confEndpoint(Endpoint & ep);
00085     bool readEndpoint(Endpoint & ep);
00086     bool endpoint_configured;
00087     bool endpoint_read;
00088     
00089 };
00090 
00091 #include "def.h"
00092 
00093 #endif