KDDI Fx0 hackathon / SNICInterface_mod

SNIC UART Interface library for Murata Type-YD module

Dependents:   WebSocketServerTest

Fork of SNICInterface_mod by Toyomasa Watarai

Socket/Socket.h@14:54378c96d285, 2014-03-26 (annotated)

Committer:
kishino
Date:
Wed Mar 26 04:38:12 2014 +0000
Revision:
14:54378c96d285
Parent:
12:0254eaccfda2 
Added a comment of copyright.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
kishino 4:99cc93fe7d88 1 /* Copyright (C) 2012 mbed.org, MIT License
kishino 4:99cc93fe7d88 2 *
kishino 4:99cc93fe7d88 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
kishino 4:99cc93fe7d88 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
kishino 4:99cc93fe7d88 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
kishino 4:99cc93fe7d88 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
kishino 4:99cc93fe7d88 7 * furnished to do so, subject to the following conditions:
kishino 4:99cc93fe7d88 8 *
kishino 4:99cc93fe7d88 9 * The above copyright notice and this permission notice shall be included in all copies or
kishino 4:99cc93fe7d88 10 * substantial portions of the Software.
kishino 4:99cc93fe7d88 11 *
kishino 4:99cc93fe7d88 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
kishino 4:99cc93fe7d88 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
kishino 4:99cc93fe7d88 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
kishino 4:99cc93fe7d88 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
kishino 4:99cc93fe7d88 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
kishino 4:99cc93fe7d88 17 */
kishino 14:54378c96d285 18 /******************* Murata Manufacturing Co.,Ltd. 2014 *****************
kishino 14:54378c96d285 19 *
kishino 14:54378c96d285 20 * Filename: Socket.h
kishino 14:54378c96d285 21 *
kishino 14:54378c96d285 22 * Purpose: This module has define of socket.
kishino 14:54378c96d285 23 *
kishino 14:54378c96d285 24 * $Author: kishino $
kishino 14:54378c96d285 25 *
kishino 14:54378c96d285 26 * $Date: 2014/03/26 $
kishino 14:54378c96d285 27 *
kishino 14:54378c96d285 28 * $Revision: 0.0.0.1 $
kishino 14:54378c96d285 29 * ***********************************************************************/
kishino 4:99cc93fe7d88 30 #ifndef SOCKET_H_
kishino 4:99cc93fe7d88 31 #define SOCKET_H_
kishino 4:99cc93fe7d88 32
kishino 12:0254eaccfda2 33 #include "SNIC_Core.h"
kishino 12:0254eaccfda2 34 #include "SNIC_UartMsgUtil.h"
kishino 4:99cc93fe7d88 35
kishino 4:99cc93fe7d88 36 typedef unsigned long socklen_t;
kishino 4:99cc93fe7d88 37
kishino 4:99cc93fe7d88 38 namespace murata_wifi
kishino 4:99cc93fe7d88 39 {
kishino 4:99cc93fe7d88 40
kishino 12:0254eaccfda2 41 #define SNIC_UART_RECVBUF_SIZE 2048
kishino 12:0254eaccfda2 42
kishino 4:99cc93fe7d88 43 /** Socket file descriptor and select wrapper
kishino 4:99cc93fe7d88 44 */
kishino 4:99cc93fe7d88 45 class Socket {
kishino 4:99cc93fe7d88 46 public:
kishino 4:99cc93fe7d88 47 /** Socket
kishino 4:99cc93fe7d88 48 */
kishino 4:99cc93fe7d88 49 Socket();
kishino 4:99cc93fe7d88 50
kishino 4:99cc93fe7d88 51 /** Set socket options
kishino 12:0254eaccfda2 52 @param level stack level (see: lwip/sockets.h)
kishino 12:0254eaccfda2 53 @param optname option ID
kishino 12:0254eaccfda2 54 @param optval option value
kishino 12:0254eaccfda2 55 @param socklen_t length of the option value
kishino 12:0254eaccfda2 56 @return 0 on success, -1 on failure
kishino 4:99cc93fe7d88 57 */
kishino 4:99cc93fe7d88 58 int set_option(int level, int optname, const void *optval, socklen_t optlen);
kishino 4:99cc93fe7d88 59
kishino 4:99cc93fe7d88 60 /** Get socket options
kishino 12:0254eaccfda2 61 @param level stack level (see: lwip/sockets.h)
kishino 12:0254eaccfda2 62 @param optname option ID
kishino 4:99cc93fe7d88 63 \param optval buffer pointer where to write the option value
kishino 4:99cc93fe7d88 64 \param socklen_t length of the option value
kishino 4:99cc93fe7d88 65 \return 0 on success, -1 on failure
kishino 12:0254eaccfda2 66 */
kishino 4:99cc93fe7d88 67 int get_option(int level, int optname, void *optval, socklen_t *optlen);
kishino 4:99cc93fe7d88 68
kishino 4:99cc93fe7d88 69 /** Close the socket
kishino 4:99cc93fe7d88 70 \param shutdown free the left-over data in message queues
kishino 4:99cc93fe7d88 71 */
kishino 4:99cc93fe7d88 72 int close(bool shutdown=true);
kishino 4:99cc93fe7d88 73
kishino 4:99cc93fe7d88 74 ~Socket();
kishino 4:99cc93fe7d88 75
kishino 12:0254eaccfda2 76 int createSocket( unsigned char bind = 0, unsigned int local_addr = 0, unsigned short port = 0 );
kishino 12:0254eaccfda2 77
kishino 4:99cc93fe7d88 78 protected:
kishino 12:0254eaccfda2 79 int mSocketID;
kishino 12:0254eaccfda2 80 C_SNIC_Core *mSnicWifi_p;
kishino 12:0254eaccfda2 81
kishino 4:99cc93fe7d88 82 #if 0
kishino 4:99cc93fe7d88 83 bool _blocking;
kishino 4:99cc93fe7d88 84 int _timeout;
kishino 4:99cc93fe7d88 85 GSwifi * _wifi;
kishino 4:99cc93fe7d88 86
kishino 4:99cc93fe7d88 87 bool _server;
kishino 4:99cc93fe7d88 88 int _cid;
kishino 4:99cc93fe7d88 89 int _port;
kishino 4:99cc93fe7d88 90 #endif
kishino 4:99cc93fe7d88 91
kishino 4:99cc93fe7d88 92 private:
kishino 12:0254eaccfda2 93
kishino 4:99cc93fe7d88 94 // int select(struct timeval *timeout, bool read, bool write);
kishino 4:99cc93fe7d88 95 };
kishino 4:99cc93fe7d88 96 }
kishino 4:99cc93fe7d88 97
kishino 4:99cc93fe7d88 98 #endif /* SOCKET_H_ */