wip
Fork of Socket by
TCPSocketConnection.h@4:75988d748e4d, 2012-07-26 (annotated)
- Committer:
- emilmont
- Date:
- Thu Jul 26 10:07:43 2012 +0000
- Revision:
- 4:75988d748e4d
- Parent:
- 3:e6474399e057
- Child:
- 5:300e7ad2dc1d
Add "const" specifier to "TCPSocketConnection::connect" parameters
Who changed what in which revision?
User | Revision | Line number | New contents of line |
---|---|---|---|
emilmont | 3:e6474399e057 | 1 | /* Copyright (C) 2012 mbed.org, MIT License |
emilmont | 3:e6474399e057 | 2 | * |
emilmont | 3:e6474399e057 | 3 | * Permission is hereby granted, free of charge, to any person obtaining a copy of this software |
emilmont | 3:e6474399e057 | 4 | * and associated documentation files (the "Software"), to deal in the Software without restriction, |
emilmont | 3:e6474399e057 | 5 | * including without limitation the rights to use, copy, modify, merge, publish, distribute, |
emilmont | 3:e6474399e057 | 6 | * sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is |
emilmont | 3:e6474399e057 | 7 | * furnished to do so, subject to the following conditions: |
emilmont | 3:e6474399e057 | 8 | * |
emilmont | 3:e6474399e057 | 9 | * The above copyright notice and this permission notice shall be included in all copies or |
emilmont | 3:e6474399e057 | 10 | * substantial portions of the Software. |
emilmont | 3:e6474399e057 | 11 | * |
emilmont | 3:e6474399e057 | 12 | * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING |
emilmont | 3:e6474399e057 | 13 | * BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
emilmont | 3:e6474399e057 | 14 | * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, |
emilmont | 3:e6474399e057 | 15 | * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, |
emilmont | 3:e6474399e057 | 16 | * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
emilmont | 3:e6474399e057 | 17 | */ |
emilmont | 3:e6474399e057 | 18 | |
emilmont | 3:e6474399e057 | 19 | #ifndef TCPSOCKET_H |
emilmont | 3:e6474399e057 | 20 | #define TCPSOCKET_H |
emilmont | 3:e6474399e057 | 21 | |
emilmont | 3:e6474399e057 | 22 | #include "Socket/Socket.h" |
emilmont | 3:e6474399e057 | 23 | |
emilmont | 3:e6474399e057 | 24 | /** |
emilmont | 3:e6474399e057 | 25 | This is a C++ abstraction for TCP networking sockets. |
emilmont | 3:e6474399e057 | 26 | */ |
emilmont | 3:e6474399e057 | 27 | class TCPSocketConnection : public Socket { |
emilmont | 3:e6474399e057 | 28 | friend class TCPSocketServer; |
emilmont | 3:e6474399e057 | 29 | |
emilmont | 3:e6474399e057 | 30 | public: |
emilmont | 3:e6474399e057 | 31 | /** Instantiate a TCP Socket. |
emilmont | 3:e6474399e057 | 32 | */ |
emilmont | 3:e6474399e057 | 33 | TCPSocketConnection(); |
emilmont | 3:e6474399e057 | 34 | |
emilmont | 3:e6474399e057 | 35 | ~TCPSocketConnection(); |
emilmont | 3:e6474399e057 | 36 | |
emilmont | 3:e6474399e057 | 37 | /** Connect the TCP Socket to the following host. |
emilmont | 3:e6474399e057 | 38 | \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS. |
emilmont | 3:e6474399e057 | 39 | \param port The host's port to connect to. |
emilmont | 3:e6474399e057 | 40 | \return 0 on success, -1 on failure. |
emilmont | 3:e6474399e057 | 41 | */ |
emilmont | 4:75988d748e4d | 42 | int connect(const char* host, const int port); |
emilmont | 3:e6474399e057 | 43 | |
emilmont | 3:e6474399e057 | 44 | /** Send data to the remote host. |
emilmont | 3:e6474399e057 | 45 | \param data The buffer to send to the host. |
emilmont | 3:e6474399e057 | 46 | \param length The length of the buffer to send. |
emilmont | 3:e6474399e057 | 47 | \param timeout The maximum amount of time in ms to wait while trying to send the buffer. |
emilmont | 3:e6474399e057 | 48 | \return the number of written bytes on success (>=0) or -1 on failure |
emilmont | 3:e6474399e057 | 49 | */ |
emilmont | 3:e6474399e057 | 50 | int send(char* data, int length, int timeout=0); |
emilmont | 3:e6474399e057 | 51 | |
emilmont | 3:e6474399e057 | 52 | /** Send data to the remote host. |
emilmont | 3:e6474399e057 | 53 | \param data The buffer to send to the host. |
emilmont | 3:e6474399e057 | 54 | \param length The length of the buffer to send. |
emilmont | 3:e6474399e057 | 55 | \param timeout The maximum amount of time in ms to wait while trying to send the buffer. |
emilmont | 3:e6474399e057 | 56 | \return the number of written bytes on success (>=0) or -1 on failure |
emilmont | 3:e6474399e057 | 57 | */ |
emilmont | 3:e6474399e057 | 58 | int send_all(char* data, int length, int timeout=0); |
emilmont | 3:e6474399e057 | 59 | |
emilmont | 3:e6474399e057 | 60 | /** Receive data from the remote host. |
emilmont | 3:e6474399e057 | 61 | \param data The buffer in which to store the data received from the host. |
emilmont | 3:e6474399e057 | 62 | \param length The maximum length of the buffer. |
emilmont | 3:e6474399e057 | 63 | \param timeout The maximum amount of time in ms to wait while trying to receive data. |
emilmont | 3:e6474399e057 | 64 | \return the number of received bytes on success (>=0) or -1 on failure |
emilmont | 3:e6474399e057 | 65 | */ |
emilmont | 3:e6474399e057 | 66 | int receive(char* data, int length, int timeout=0); |
emilmont | 3:e6474399e057 | 67 | |
emilmont | 3:e6474399e057 | 68 | /** Receive data from the remote host. |
emilmont | 3:e6474399e057 | 69 | \param data The buffer in which to store the data received from the host. |
emilmont | 3:e6474399e057 | 70 | \param length The maximum length of the buffer. |
emilmont | 3:e6474399e057 | 71 | \param timeout The maximum amount of time in ms to wait while trying to receive data. |
emilmont | 3:e6474399e057 | 72 | \return the number of received bytes on success (>=0) or -1 on failure |
emilmont | 3:e6474399e057 | 73 | */ |
emilmont | 3:e6474399e057 | 74 | int receive_all(char* data, int length, int timeout=0); |
emilmont | 3:e6474399e057 | 75 | |
emilmont | 3:e6474399e057 | 76 | char* get_address(); |
emilmont | 3:e6474399e057 | 77 | int get_port(); |
emilmont | 3:e6474399e057 | 78 | |
emilmont | 3:e6474399e057 | 79 | private: |
emilmont | 3:e6474399e057 | 80 | char _ipAddress[16]; |
emilmont | 3:e6474399e057 | 81 | |
emilmont | 3:e6474399e057 | 82 | bool _closedByRemoteHost; |
emilmont | 3:e6474399e057 | 83 | struct sockaddr_in _remoteHost; |
emilmont | 3:e6474399e057 | 84 | |
emilmont | 3:e6474399e057 | 85 | }; |
emilmont | 3:e6474399e057 | 86 | |
emilmont | 3:e6474399e057 | 87 | #endif |