Wayne Jay / EthernetInterface

Onenet

Dependents:   K64F_eCompass_OneNET_JW

Socket/UDPSocket.h@0:b2805b6888dc, 2016-06-20 (annotated)

Committer:
robert_jw
Date:
Mon Jun 20 01:40:20 2016 +0000
Revision:
0:b2805b6888dc
ADS

Who changed what in which revision?

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