u-blox / Mbed 2 deprecated IBMIoTClientEthernetExample

Port to C027 (using AppShield and Ethernet)

Dependencies:   C12832 EthernetInterface LM75B MMA7660 MQTT mbed-rtos mbed

Fork of IBMIoTClientEthernetExample by IBM Watson IoT

EthernetInterface/Socket/UDPSocket.h@6:37b6d0d56190, 2014-08-20 (annotated)

Committer:
samdanbury
Date:
Wed Aug 20 12:45:14 2014 +0000
Revision:
6:37b6d0d56190
Code completely changed to improve the structure, flow and memory usage of the application

Who changed what in which revision?

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