Yihui Xiong / WiflyInterface

WIFI library for WIFI Shield of Seeed Studio

Fork of WiflyInterface by mbed official

Socket/TCPSocketConnection.h@5:26ae56c7cb3d, 2013-12-19 (annotated)

Committer:
yihui
Date:
Thu Dec 19 09:56:59 2013 +0000
Revision:
5:26ae56c7cb3d
Parent:
1:fb4494783863 
for wifi shield of Seeed Studio

Who changed what in which revision?

UserRevisionLine numberNew contents of line
samux 1:fb4494783863 1 /* Copyright (C) 2012 mbed.org, MIT License
samux 1:fb4494783863 2 *
samux 1:fb4494783863 3 * Permission is hereby granted, free of charge, to any person obtaining a copy of this software
samux 1:fb4494783863 4 * and associated documentation files (the "Software"), to deal in the Software without restriction,
samux 1:fb4494783863 5 * including without limitation the rights to use, copy, modify, merge, publish, distribute,
samux 1:fb4494783863 6 * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is
samux 1:fb4494783863 7 * furnished to do so, subject to the following conditions:
samux 1:fb4494783863 8 *
samux 1:fb4494783863 9 * The above copyright notice and this permission notice shall be included in all copies or
samux 1:fb4494783863 10 * substantial portions of the Software.
samux 1:fb4494783863 11 *
samux 1:fb4494783863 12 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING
samux 1:fb4494783863 13 * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
samux 1:fb4494783863 14 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
samux 1:fb4494783863 15 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
samux 1:fb4494783863 16 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
samux 1:fb4494783863 17 */
samux 1:fb4494783863 18
samux 1:fb4494783863 19 #ifndef TCPSOCKET_H
samux 1:fb4494783863 20 #define TCPSOCKET_H
samux 1:fb4494783863 21
samux 1:fb4494783863 22 #include "Socket.h"
samux 1:fb4494783863 23 #include "Endpoint.h"
samux 1:fb4494783863 24
samux 1:fb4494783863 25 /**
samux 1:fb4494783863 26 TCP socket connection
samux 1:fb4494783863 27 */
samux 1:fb4494783863 28 class TCPSocketConnection: public Socket, public Endpoint {
samux 1:fb4494783863 29
samux 1:fb4494783863 30 public:
samux 1:fb4494783863 31 /** TCP socket connection
samux 1:fb4494783863 32 */
samux 1:fb4494783863 33 TCPSocketConnection();
samux 1:fb4494783863 34
samux 1:fb4494783863 35 /** Connects this TCP socket to the server
samux 1:fb4494783863 36 \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
samux 1:fb4494783863 37 \param port The host's port to connect to.
samux 1:fb4494783863 38 \return 0 on success, -1 on failure.
samux 1:fb4494783863 39 */
samux 1:fb4494783863 40 int connect(const char* host, const int port);
samux 1:fb4494783863 41
samux 1:fb4494783863 42 /** Check if the socket is connected
samux 1:fb4494783863 43 \return true if connected, false otherwise.
samux 1:fb4494783863 44 */
samux 1:fb4494783863 45 bool is_connected(void);
samux 1:fb4494783863 46
samux 1:fb4494783863 47 /** Send data to the remote host.
samux 1:fb4494783863 48 \param data The buffer to send to the host.
samux 1:fb4494783863 49 \param length The length of the buffer to send.
samux 1:fb4494783863 50 \return the number of written bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 51 */
samux 1:fb4494783863 52 int send(char* data, int length);
samux 1:fb4494783863 53
samux 1:fb4494783863 54 /** Send all the data to the remote host.
samux 1:fb4494783863 55 \param data The buffer to send to the host.
samux 1:fb4494783863 56 \param length The length of the buffer to send.
samux 1:fb4494783863 57 \return the number of written bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 58 */
samux 1:fb4494783863 59 int send_all(char* data, int length);
samux 1:fb4494783863 60
samux 1:fb4494783863 61 /** Receive data from the remote host.
samux 1:fb4494783863 62 \param data The buffer in which to store the data received from the host.
samux 1:fb4494783863 63 \param length The maximum length of the buffer.
samux 1:fb4494783863 64 \return the number of received bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 65 */
samux 1:fb4494783863 66 int receive(char* data, int length);
samux 1:fb4494783863 67
samux 1:fb4494783863 68 /** Receive all the data from the remote host.
samux 1:fb4494783863 69 \param data The buffer in which to store the data received from the host.
samux 1:fb4494783863 70 \param length The maximum length of the buffer.
samux 1:fb4494783863 71 \return the number of received bytes on success (>=0) or -1 on failure
samux 1:fb4494783863 72 */
samux 1:fb4494783863 73 int receive_all(char* data, int length);
samux 1:fb4494783863 74 };
samux 1:fb4494783863 75
samux 1:fb4494783863 76 #endif