GSwifiInterface library (interface for GainSpan Wi-Fi GS1011 modules) Please see https://mbed.org/users/gsfan/notebook/GSwifiInterface/

Dependents:   GSwifiInterface_HelloWorld GSwifiInterface_HelloServo GSwifiInterface_UDPEchoServer GSwifiInterface_UDPEchoClient ... more

Fork of WiflyInterface by mbed official

Embed: (wiki syntax)

« Back to documentation index

Show/hide line numbers UDPSocket.h Source File

UDPSocket.h

00001 /* Copyright (C) 2012 mbed.org, MIT License
00002  *
00003  * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
00004  * and associated documentation files (the "Software"), to deal in the Software without restriction,
00005  * including without limitation the rights to use, copy, modify, merge, publish, distribute,
00006  * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
00007  * furnished to do so, subject to the following conditions:
00008  *
00009  * The above copyright notice and this permission notice shall be included in all copies or
00010  * substantial portions of the Software.
00011  *
00012  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
00013  * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
00014  * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
00015  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
00016  * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
00017  */
00018 /* Copyright (C) 2013 gsfan, MIT License
00019  *  port to the GainSpan Wi-FI module GS1011
00020  */
00021 
00022 #ifndef UDPSOCKET_H
00023 #define UDPSOCKET_H
00024 
00025 #include "Endpoint.h"
00026 #include "Socket.h"
00027 
00028 #include <cstdint>
00029 
00030 /**
00031 UDP Socket
00032 */
00033 class UDPSocket: public Socket {
00034 
00035 public:
00036     /** Instantiate an UDP Socket.
00037     */
00038     UDPSocket();
00039     
00040     /** Init the UDP Client Socket without binding it to any specific port
00041     \return 0 on success, -1 on failure.
00042     */
00043     int init(void);
00044     
00045     /** Bind a UDP Server Socket to a specific port
00046     \param port The port to listen for incoming connections on
00047     \return 0 on success, -1 on failure.
00048     */
00049     int bind(int port = -1);
00050     
00051     /** Send a packet to a remote endpoint
00052     \param remote   The remote endpoint
00053     \param packet   The packet to be sent
00054     \param length   The length of the packet to be sent
00055     \return the number of written bytes on success (>=0) or -1 on failure
00056     */
00057     int sendTo(Endpoint &remote, char *packet, int length);
00058     
00059     /** Receive a packet from a remote endpoint
00060     \param remote   The remote endpoint
00061     \param buffer   The buffer for storing the incoming packet data. If a packet
00062            is too long to fit in the supplied buffer, excess bytes are discarded
00063     \param length   The length of the buffer
00064     \return the number of received bytes on success (>=0) or -1 on failure
00065     */
00066     int receiveFrom(Endpoint &remote, char *buffer, int length);
00067     
00068 private:
00069     bool endpoint_connected;
00070     
00071 };
00072 
00073 #include "def.h"
00074 
00075 #endif