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) 2014 Murata Manufacturing Co.,Ltd., MIT License
00019  *  port to the muRata, SWITCH SCIENCE Wi-FI module TypeYD SNIC-UART.
00020  */
00021 #ifndef UDPSOCKET_H
00022 #define UDPSOCKET_H
00023 
00024 #include "Socket.h"
00025 #include "Endpoint.h"
00026 
00027 /**
00028 Interface class for UDP socket of using SNIC UART.
00029 */
00030 class UDPSocket : public Socket {
00031 
00032 public:
00033     /** Instantiate an UDP Socket.
00034     */
00035     UDPSocket();
00036     virtual ~UDPSocket();
00037     
00038     /** Init the UDP Client Socket without binding it to any specific port
00039     \return 0 on success, -1 on failure.
00040     */
00041     int init(void);
00042     
00043     /** Bind a UDP Server Socket to a specific port
00044     \param port The port to listen for incoming connections on
00045     \return 0 on success, -1 on failure.
00046     */
00047     int bind(short port);
00048     
00049     /** Send a packet to a remote endpoint
00050     \param remote   The remote endpoint
00051     \param packet   The packet to be sent
00052     \param length   The length of the packet to be sent
00053     \return the number of written bytes on success (>=0) or -1 on failure
00054     */
00055     int sendTo(Endpoint &remote, char *packet, int length);
00056     
00057     /** Receive a packet from a remote endpoint
00058     \param remote   The remote endpoint
00059     \param buffer   The buffer for storing the incoming packet data. If a packet
00060            is too long to fit in the supplied buffer, excess bytes are discarded
00061     \param length   The length of the buffer
00062     \return the number of received bytes on success (>=0) or -1 on failure
00063     */
00064     int receiveFrom(Endpoint &remote, char *buffer, int length);
00065 };
00066 
00067 #endif