Junichi Katsu / Milkcocoa

データの保存、更新、取得ができるWebサービス「milkcocoa」に接続し、データのプッシュ、送信、取得ができるライブラリです。 https://mlkcca.com/

Dependencies:   MQTT

Dependents:   MilkcocoaSample MilkcocoaSampleESP8266_LED MilkcocoaSampleESP8266 MilkcocoaSample_3G ... more

ESP8266InterfaceTiny/Socket/UDPSocket.h@0:23e533c4b1ec, 2015-12-15 (annotated)

Committer:
jksoft
Date:
Tue Dec 15 09:56:32 2015 +0000
Revision:
0:23e533c4b1ec
??; Subscribe?1?????; ?Milkcocoa::on???????????????????????

Who changed what in which revision?

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