UDPSocket.h

00001 /*
00002  * Copyright (C) 2013 gsfan, MIT License
00003  *
00004  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00005  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00006  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00007  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00008  * furnished to do so, subject to the following conditions:
00009  *
00010  * The above copyright notice and this permission notice shall be included in all copies or
00011  * substantial portions of the Software.
00012  *
00013  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00014  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00015  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00016  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00017  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00018  */
00019 /* Copyright (C) 2014 Wiznet, MIT License
00020  *  port to the Wiznet Module WizFi250
00021  */
00022 /* Copyright (C) 2017 Wiznet, MIT License
00023  *  port to the Wiznet Module WizFi310
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     /** Send a packet to a remote endpoint
00056     \param remote   The remote endpoint
00057     \param packet   The packet to be sent
00058     \param length   The length of the packet to be sent
00059     \return the number of written bytes on success (>=0) or -1 on failure
00060     */
00061     int sendTo(Endpoint &remote, char *packet, int length);
00062 
00063     /** Receive a packet from a remote endpoint
00064     \param remote   The remote endpoint
00065     \param buffer   The buffer for storing the incoming packet data. If a packet
00066            is too long to fit in the supplied buffer, excess bytes are discarded
00067     \param length   The length of the buffer
00068     \return the number of received bytes on success (>=0) or -1 on failure
00069     */
00070     int receiveFrom(Endpoint &remote, char *buffer, int length);
00071 
00072 private:
00073     bool endpoint_connected;
00074 
00075 };
00076 
00077 #include "def.h"
00078 
00079 #endif