Lee Kai Xuan / mbed-os

mbed-os

Fork of mbed-os by erkin yucel

features/unsupported/net/lwip/Socket/UDPSocket.h@0:f269e3021894, 2016-10-23 (annotated)

Committer:
elessair
Date:
Sun Oct 23 15:10:02 2016 +0000
Revision:
0:f269e3021894
Initial commit

Who changed what in which revision?

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