Jan Korycan / WNCInterface

WNCInterface

Dependencies:   WncControllerK64F

Fork of WNCInterface by Avnet

Socket/WncTCPSocketConnection.h@26:81e520908460, 2017-03-24 (annotated)

Committer:
JMF
Date:
Fri Mar 24 21:43:57 2017 +0000
Revision:
26:81e520908460
Parent:
Socket/TCPSocketConnection.h@1:e511ea8d39d5
Child:
27:2dc9461c04dc
Changing WNC Networking Class names to be prefixed with "Wnc" so they don't collide with the standard networking classes.

Who changed what in which revision?

UserRevisionLine numberNew contents of line
JMF 1:e511ea8d39d5 1 /* =====================================================================
JMF 1:e511ea8d39d5 2 Copyright © 2016, Avnet (R)
JMF 1:e511ea8d39d5 3
JMF 1:e511ea8d39d5 4 Contributors:
JMF 1:e511ea8d39d5 5 * James M Flynn, www.em.avnet.com
JMF 1:e511ea8d39d5 6
JMF 1:e511ea8d39d5 7 Licensed under the Apache License, Version 2.0 (the "License");
JMF 1:e511ea8d39d5 8 you may not use this file except in compliance with the License.
JMF 1:e511ea8d39d5 9 You may obtain a copy of the License at
JMF 1:e511ea8d39d5 10
JMF 1:e511ea8d39d5 11 http://www.apache.org/licenses/LICENSE-2.0
JMF 1:e511ea8d39d5 12
JMF 1:e511ea8d39d5 13 Unless required by applicable law or agreed to in writing,
JMF 1:e511ea8d39d5 14 software distributed under the License is distributed on an
JMF 1:e511ea8d39d5 15 "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
JMF 1:e511ea8d39d5 16 either express or implied. See the License for the specific
JMF 1:e511ea8d39d5 17 language governing permissions and limitations under the License.
JMF 1:e511ea8d39d5 18
JMF 1:e511ea8d39d5 19 @file WNCInterface.cpp
JMF 1:e511ea8d39d5 20 @version 1.0
JMF 1:e511ea8d39d5 21 @date Sept 2016
JMF 1:e511ea8d39d5 22
JMF 1:e511ea8d39d5 23 ======================================================================== */
JMF 1:e511ea8d39d5 24
JMF 1:e511ea8d39d5 25 #ifndef TCPSOCKET_H
JMF 1:e511ea8d39d5 26 #define TCPSOCKET_H
JMF 1:e511ea8d39d5 27
JMF 26:81e520908460 28 #include "WncSocket.h"
JMF 26:81e520908460 29 #include "WncEndpoint.h"
JMF 1:e511ea8d39d5 30
JMF 1:e511ea8d39d5 31 /**
JMF 1:e511ea8d39d5 32 TCP socket connection
JMF 1:e511ea8d39d5 33 */
JMF 1:e511ea8d39d5 34 class TCPSocketConnection : public Socket, public Endpoint {
JMF 1:e511ea8d39d5 35
JMF 1:e511ea8d39d5 36 public:
JMF 1:e511ea8d39d5 37 TCPSocketConnection();
JMF 1:e511ea8d39d5 38
JMF 1:e511ea8d39d5 39 /** Connects this TCP socket to the server
JMF 1:e511ea8d39d5 40 \param host The host to connect to. It can either be an IP Address or a hostname that will be resolved with DNS.
JMF 1:e511ea8d39d5 41 \param port The host's port to connect to.
JMF 1:e511ea8d39d5 42 \return 0 on success, -1 on failure.
JMF 1:e511ea8d39d5 43 */
JMF 1:e511ea8d39d5 44 int connect(const char* host, const int port);
JMF 1:e511ea8d39d5 45
JMF 1:e511ea8d39d5 46 /** Check if the socket is connected
JMF 1:e511ea8d39d5 47 \return true if connected, false otherwise.
JMF 1:e511ea8d39d5 48 */
JMF 1:e511ea8d39d5 49 bool is_connected(void);
JMF 1:e511ea8d39d5 50
JMF 1:e511ea8d39d5 51 /** Send data to the remote host.
JMF 1:e511ea8d39d5 52 \param data The buffer to send to the host.
JMF 1:e511ea8d39d5 53 \param length The length of the buffer to send.
JMF 1:e511ea8d39d5 54 \return the number of written bytes on success (>=0) or -1 on failure
JMF 1:e511ea8d39d5 55 */
JMF 1:e511ea8d39d5 56 int send(char* data, int length);
JMF 1:e511ea8d39d5 57
JMF 1:e511ea8d39d5 58 /** Send all the data to the remote host.
JMF 1:e511ea8d39d5 59 \param data The buffer to send to the host.
JMF 1:e511ea8d39d5 60 \param length The length of the buffer to send.
JMF 1:e511ea8d39d5 61 \return the number of written bytes on success (>=0) or -1 on failure
JMF 1:e511ea8d39d5 62 */
JMF 1:e511ea8d39d5 63 int send_all(char* data, int length);
JMF 1:e511ea8d39d5 64
JMF 1:e511ea8d39d5 65 /** Receive data from the remote host.
JMF 1:e511ea8d39d5 66 \param data The buffer in which to store the data received from the host.
JMF 1:e511ea8d39d5 67 \param length The maximum length of the buffer.
JMF 1:e511ea8d39d5 68 \return the number of received bytes on success (>=0) or -1 on failure
JMF 1:e511ea8d39d5 69 */
JMF 1:e511ea8d39d5 70 int receive(char* data, int length);
JMF 1:e511ea8d39d5 71
JMF 1:e511ea8d39d5 72 /** Receive all the data from the remote host.
JMF 1:e511ea8d39d5 73 \param data The buffer in which to store the data received from the host.
JMF 1:e511ea8d39d5 74 \param length The maximum length of the buffer.
JMF 1:e511ea8d39d5 75 \return the number of received bytes on success (>=0) or -1 on failure
JMF 1:e511ea8d39d5 76 */
JMF 1:e511ea8d39d5 77 int receive_all(char* data, int length);
JMF 1:e511ea8d39d5 78
JMF 1:e511ea8d39d5 79 /** Set blocking or non-blocking mode of the socket and a timeout
JMF 1:e511ea8d39d5 80 \param blocking true for blocking mode, false for non-blocking mode.
JMF 1:e511ea8d39d5 81 \return none
JMF 1:e511ea8d39d5 82 */
JMF 1:e511ea8d39d5 83 void set_blocking (bool blocking, unsigned int timeout=1500);
JMF 1:e511ea8d39d5 84
JMF 1:e511ea8d39d5 85 /** Close the socket
JMF 1:e511ea8d39d5 86 \param none
JMF 1:e511ea8d39d5 87 \return 0 if closed successfully, -1 on failure
JMF 1:e511ea8d39d5 88 */
JMF 1:e511ea8d39d5 89 int close(void);
JMF 1:e511ea8d39d5 90
JMF 1:e511ea8d39d5 91 private:
JMF 1:e511ea8d39d5 92 bool _is_blocking;
JMF 1:e511ea8d39d5 93 unsigned int _btimeout;
JMF 1:e511ea8d39d5 94
JMF 1:e511ea8d39d5 95 };
JMF 1:e511ea8d39d5 96
JMF 1:e511ea8d39d5 97 #endif