SNIC UART Interface library for Murata Type-YD module
Dependents: WebSocketServerTest
Fork of SNICInterface_mod by
Socket/TCPSocketConnection.h@25:67183ed15708, 2014-03-28 (annotated)
- Committer:
- kishino
- Date:
- Fri Mar 28 01:56:08 2014 +0000
- Revision:
- 25:67183ed15708
- Parent:
- 23:4ff2231ff9ba
- Child:
- 26:f2e1030964e4
Created a base class for Murata named C_MurataObject.
Who changed what in which revision?
User | Revision | Line number | New 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: TCPSocketConnection.h |
kishino | 20:dd736d328de6 | 21 | * |
kishino | 20:dd736d328de6 | 22 | * Purpose: This module has define of TCP connection. |
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 TCPSOCKET_H |
kishino | 20:dd736d328de6 | 32 | #define TCPSOCKET_H |
kishino | 20:dd736d328de6 | 33 | |
kishino | 25:67183ed15708 | 34 | #include "MurataObject.h" |
kishino | 20:dd736d328de6 | 35 | #include "Socket.h" |
kishino | 20:dd736d328de6 | 36 | #include "Endpoint.h" |
kishino | 20:dd736d328de6 | 37 | |
kishino | 20:dd736d328de6 | 38 | namespace murata_wifi |
kishino | 20:dd736d328de6 | 39 | { |
kishino | 20:dd736d328de6 | 40 | |
kishino | 20:dd736d328de6 | 41 | /** |
kishino | 23:4ff2231ff9ba | 42 | Interface class for TCP socket of using SNIC UART. |
kishino | 20:dd736d328de6 | 43 | */ |
kishino | 20:dd736d328de6 | 44 | class TCPSocketConnection : public Socket, public Endpoint { |
kishino | 20:dd736d328de6 | 45 | |
kishino | 20:dd736d328de6 | 46 | public: |
kishino | 20:dd736d328de6 | 47 | /** TCP socket connection |
kishino | 20:dd736d328de6 | 48 | */ |
kishino | 20:dd736d328de6 | 49 | TCPSocketConnection(); |
kishino | 20:dd736d328de6 | 50 | |
kishino | 20:dd736d328de6 | 51 | /** Connects this TCP socket to the server |
kishino | 20:dd736d328de6 | 52 | @param host The ip address to connect to.(hexadecimal)("192.168.0.1"->0xC0A80001) |
kishino | 20:dd736d328de6 | 53 | @param port The host's port to connect to. |
kishino | 20:dd736d328de6 | 54 | @return 0 on success, -1 on failure. |
kishino | 20:dd736d328de6 | 55 | @note This function is blocked until a returns. |
kishino | 20:dd736d328de6 | 56 | When you use it by UI thread, be careful. |
kishino | 20:dd736d328de6 | 57 | */ |
kishino | 20:dd736d328de6 | 58 | int connect( unsigned int ip_addr, unsigned short port ); |
kishino | 20:dd736d328de6 | 59 | |
kishino | 20:dd736d328de6 | 60 | /** Check if the socket is connected |
kishino | 20:dd736d328de6 | 61 | @return true if connected, false otherwise. |
kishino | 20:dd736d328de6 | 62 | */ |
kishino | 20:dd736d328de6 | 63 | bool is_connected(void); |
kishino | 20:dd736d328de6 | 64 | |
kishino | 20:dd736d328de6 | 65 | /** Send data to the remote host. |
kishino | 20:dd736d328de6 | 66 | @param data The buffer to send to the host. |
kishino | 20:dd736d328de6 | 67 | @param length The length of the buffer to send. |
kishino | 20:dd736d328de6 | 68 | @return the number of written bytes on success (>=0) or -1 on failure |
kishino | 20:dd736d328de6 | 69 | */ |
kishino | 20:dd736d328de6 | 70 | int send(unsigned char *data_p, int length); |
kishino | 20:dd736d328de6 | 71 | |
kishino | 20:dd736d328de6 | 72 | /** Receive data from the remote host. |
kishino | 20:dd736d328de6 | 73 | @param data The buffer in which to store the data received from the host. |
kishino | 20:dd736d328de6 | 74 | @param length The maximum length of the buffer. |
kishino | 20:dd736d328de6 | 75 | @return the number of received bytes on success (>=0) or -1 on failure |
kishino | 20:dd736d328de6 | 76 | */ |
kishino | 20:dd736d328de6 | 77 | int receive(unsigned char *data_p, int length); |
kishino | 20:dd736d328de6 | 78 | |
kishino | 20:dd736d328de6 | 79 | private: |
kishino | 20:dd736d328de6 | 80 | |
kishino | 20:dd736d328de6 | 81 | }; |
kishino | 20:dd736d328de6 | 82 | } |
kishino | 20:dd736d328de6 | 83 | #endif |