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