KDDI Fx0 hackathon / SNICInterface_mod2

Customized

Dependents:   MurataTypeYD_RPC_Sample

Fork of SNICInterface_mod by Toyomasa Watarai

Socket/UDPSocket.h@23:4ff2231ff9ba, 2014-03-27 (annotated)

Committer:
kishino
Date:
Thu Mar 27 10:11:59 2014 +0000
Revision:
23:4ff2231ff9ba
Parent:
20:dd736d328de6
Child:
25:67183ed15708
Modified the description of classes.

Who changed what in which revision?

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