CK Sin / Mbed 2 deprecated Ethernetwebsocket

Ethernetwebsoc

Dependencies:   C12832_lcd LM75B WebSocketClient mbed-rtos mbed Socket lwip-eth lwip-sys lwip

EthernetInterface/Socket/UDPSocket.h@0:0ed2a7c7190c, 2013-05-31 (annotated)

Committer:
GordonSin
Date:
Fri May 31 04:09:54 2013 +0000
Revision:
0:0ed2a7c7190c
31/5/2013;

Who changed what in which revision?

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