Patrick Pollet / EthernetInterfaceW5500

Ethernet interface for W5500 with bug fixed in socket::close()

Fork of EthernetInterfaceW5500 by W5500-Ethernet-Interface Makers

Socket/UDPSocket.h@15:fe68ac753657, 2014-08-29 (annotated)

Committer:
ppo
Date:
Fri Aug 29 12:00:38 2014 +0000
Revision:
15:fe68ac753657
Parent:
10:cadac6bcd169 
bug fixed in close(), now socket is really closed

Who changed what in which revision?

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