Samuel Mokrani / WiflyInterface

wifly/socket interface for wifly modules

Dependents:   WiFi neurGAI_WIFI thingspeak thingspeak2

Socket/UDPSocket.h@13:108340829acc, 2012-08-24 (annotated)

Committer:
samux
Date:
Fri Aug 24 13:25:55 2012 +0000
Revision:
13:108340829acc
Parent:
0:6ffb0aeb3972 
reduce buffer size

Who changed what in which revision?

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