Junichi Katsu / MultiIoTBoardLib

test

Dependencies:   BME280 SB1602E

Fork of MultiIoTBoardLib by Junichi Katsu

ESP8266InterfaceTiny/Socket/UDPSocket.h@0:bad9495b4215, 2017-07-28 (annotated)

Committer:
jksoft
Date:
Fri Jul 28 02:23:25 2017 +0000
Revision:
0:bad9495b4215
First edition

Who changed what in which revision?

UserRevisionLine numberNew contents of line
jksoft 0:bad9495b4215 1 /* Copyright (C) 2012 mbed.org, MIT License
jksoft 0:bad9495b4215 2 *
jksoft 0:bad9495b4215 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
jksoft 0:bad9495b4215 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
jksoft 0:bad9495b4215 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
jksoft 0:bad9495b4215 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
jksoft 0:bad9495b4215 7 * furnished to do so, subject to the following conditions:
jksoft 0:bad9495b4215 8 *
jksoft 0:bad9495b4215 9 * The above copyright notice and this permission notice shall be included in all copies or
jksoft 0:bad9495b4215 10 * substantial portions of the Software.
jksoft 0:bad9495b4215 11 *
jksoft 0:bad9495b4215 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
jksoft 0:bad9495b4215 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
jksoft 0:bad9495b4215 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
jksoft 0:bad9495b4215 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
jksoft 0:bad9495b4215 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
jksoft 0:bad9495b4215 17 */
jksoft 0:bad9495b4215 18
jksoft 0:bad9495b4215 19 #ifndef UDPSOCKET_H
jksoft 0:bad9495b4215 20 #define UDPSOCKET_H
jksoft 0:bad9495b4215 21
jksoft 0:bad9495b4215 22 #include "Endpoint.h"
jksoft 0:bad9495b4215 23 #include "Socket.h"
jksoft 0:bad9495b4215 24
jksoft 0:bad9495b4215 25 #include <cstdint>
jksoft 0:bad9495b4215 26
jksoft 0:bad9495b4215 27 /**
jksoft 0:bad9495b4215 28 UDP Socket
jksoft 0:bad9495b4215 29 */
jksoft 0:bad9495b4215 30 class UDPSocket: public Socket {
jksoft 0:bad9495b4215 31
jksoft 0:bad9495b4215 32 public:
jksoft 0:bad9495b4215 33 /** Instantiate an UDP Socket.
jksoft 0:bad9495b4215 34 */
jksoft 0:bad9495b4215 35 UDPSocket();
jksoft 0:bad9495b4215 36
jksoft 0:bad9495b4215 37 /** Init the UDP Client Socket without binding it to any specific port
jksoft 0:bad9495b4215 38 \return 0 on success, -1 on failure.
jksoft 0:bad9495b4215 39 */
jksoft 0:bad9495b4215 40 int init(void);
jksoft 0:bad9495b4215 41
jksoft 0:bad9495b4215 42 /** Bind a UDP Server Socket to a specific port
jksoft 0:bad9495b4215 43 \param port The port to listen for incoming connections on
jksoft 0:bad9495b4215 44 \return 0 on success, -1 on failure.
jksoft 0:bad9495b4215 45 */
jksoft 0:bad9495b4215 46 int bind(int port = -1);
jksoft 0:bad9495b4215 47
jksoft 0:bad9495b4215 48 /** Send a packet to a remote endpoint
jksoft 0:bad9495b4215 49 \param remote The remote endpoint
jksoft 0:bad9495b4215 50 \param packet The packet to be sent
jksoft 0:bad9495b4215 51 \param length The length of the packet to be sent
jksoft 0:bad9495b4215 52 \return the number of written bytes on success (>=0) or -1 on failure
jksoft 0:bad9495b4215 53 */
jksoft 0:bad9495b4215 54 int sendTo(Endpoint &remote, char *packet, int length);
jksoft 0:bad9495b4215 55
jksoft 0:bad9495b4215 56 /** Receive a packet from a remote endpoint
jksoft 0:bad9495b4215 57 \param remote The remote endpoint
jksoft 0:bad9495b4215 58 \param buffer The buffer for storing the incoming packet data. If a packet
jksoft 0:bad9495b4215 59 is too long to fit in the supplied buffer, excess bytes are discarded
jksoft 0:bad9495b4215 60 \param length The length of the buffer
jksoft 0:bad9495b4215 61 \return the number of received bytes on success (>=0) or -1 on failure
jksoft 0:bad9495b4215 62 */
jksoft 0:bad9495b4215 63 int receiveFrom(Endpoint &remote, char *buffer, int length);
jksoft 0:bad9495b4215 64
jksoft 0:bad9495b4215 65 private:
jksoft 0:bad9495b4215 66 bool confEndpoint(Endpoint & ep);
jksoft 0:bad9495b4215 67 bool readEndpoint(Endpoint & ep);
jksoft 0:bad9495b4215 68 bool endpoint_configured;
jksoft 0:bad9495b4215 69 bool endpoint_read;
jksoft 0:bad9495b4215 70 Endpoint currentEndpoint;
jksoft 0:bad9495b4215 71
jksoft 0:bad9495b4215 72 };
jksoft 0:bad9495b4215 73
jksoft 0:bad9495b4215 74 #include "def.h"
jksoft 0:bad9495b4215 75
jksoft 0:bad9495b4215 76 #endif