DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

TCPSocket.h@90:0a988e4abb72, 2016-04-19 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 19 18:22:15 2016 -0500
Revision:
90:0a988e4abb72
Parent:
89:b1d417383c0d
Child:
92:dd5f19874adf
Add open call as alternative to passing NetworkInterface at construction



Pros

- Allows memory to be statically allocated

- Avoids issues with Thread creation before entering main

- Matches existing APIs such as FunctionPointer and Ticker



Cons

- Does not enforce passing a NetworkInterface

Who changed what in which revision?

UserRevisionLine numberNew contents of line
Christopher Haster 78:0914f9b9b24b 1 /* Socket
Christopher Haster 78:0914f9b9b24b 2 * Copyright (c) 2015 ARM Limited
Christopher Haster 72:6a8b52ee83ed 3 *
Christopher Haster 78:0914f9b9b24b 4 * Licensed under the Apache License, Version 2.0 (the "License");
Christopher Haster 78:0914f9b9b24b 5 * you may not use this file except in compliance with the License.
Christopher Haster 78:0914f9b9b24b 6 * You may obtain a copy of the License at
Christopher Haster 72:6a8b52ee83ed 7 *
Christopher Haster 78:0914f9b9b24b 8 * http://www.apache.org/licenses/LICENSE-2.0
Christopher Haster 72:6a8b52ee83ed 9 *
Christopher Haster 78:0914f9b9b24b 10 * Unless required by applicable law or agreed to in writing, software
Christopher Haster 78:0914f9b9b24b 11 * distributed under the License is distributed on an "AS IS" BASIS,
Christopher Haster 78:0914f9b9b24b 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
Christopher Haster 78:0914f9b9b24b 13 * See the License for the specific language governing permissions and
Christopher Haster 78:0914f9b9b24b 14 * limitations under the License.
Christopher Haster 72:6a8b52ee83ed 15 */
Christopher Haster 72:6a8b52ee83ed 16
Christopher Haster 72:6a8b52ee83ed 17 #ifndef TCPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 18 #define TCPSOCKET_H
Christopher Haster 72:6a8b52ee83ed 19
Christopher Haster 72:6a8b52ee83ed 20 #include "Socket.h"
Christopher Haster 77:b66a6984ed2d 21 #include "NetworkInterface.h"
Christopher Haster 72:6a8b52ee83ed 22
Christopher Haster 89:b1d417383c0d 23 /** TCP socket connection
Christopher Haster 89:b1d417383c0d 24 */
Christopher Haster 72:6a8b52ee83ed 25 class TCPSocket : public Socket {
Christopher Haster 72:6a8b52ee83ed 26 public:
Christopher Haster 72:6a8b52ee83ed 27 /** TCP socket lifetime
Christopher Haster 89:b1d417383c0d 28 */
Christopher Haster 90:0a988e4abb72 29 TCPSocket();
Christopher Haster 77:b66a6984ed2d 30 TCPSocket(NetworkInterface *iface);
Christopher Haster 81:1600369a29dd 31 virtual ~TCPSocket();
Christopher Haster 90:0a988e4abb72 32
Christopher Haster 90:0a988e4abb72 33 /** Open the socket
Christopher Haster 90:0a988e4abb72 34 * @param iface Interface to open socket on
Christopher Haster 90:0a988e4abb72 35 */
Christopher Haster 90:0a988e4abb72 36 virtual int open(NetworkInterface *iface);
Christopher Haster 72:6a8b52ee83ed 37
Christopher Haster 72:6a8b52ee83ed 38 /** Connects this TCP socket to the server
Christopher Haster 89:b1d417383c0d 39 * @param host The host to connect to. It can either be an IP Address
Christopher Haster 89:b1d417383c0d 40 * or a hostname that will be resolved with DNS
Christopher Haster 89:b1d417383c0d 41 * @param port The host's port to connect to
Christopher Haster 89:b1d417383c0d 42 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 43 */
Christopher Haster 79:43a7e8c0d6cc 44 int connect(const char *host, uint16_t port);
Christopher Haster 75:dea0cdb42241 45
Christopher Haster 75:dea0cdb42241 46 /** Connects this TCP socket to the server
Christopher Haster 89:b1d417383c0d 47 * @param address SocketAddress to connect to
Christopher Haster 89:b1d417383c0d 48 * @return 0 on success, negative on failure
Christopher Haster 89:b1d417383c0d 49 */
Christopher Haster 80:9c6673c93082 50 int connect(const SocketAddress &address);
Christopher Haster 72:6a8b52ee83ed 51
Christopher Haster 72:6a8b52ee83ed 52 /** Check if the socket is connected
Christopher Haster 89:b1d417383c0d 53 * @return true if connected, false otherwise
Christopher Haster 89:b1d417383c0d 54 */
Christopher Haster 76:bbe51641f405 55 bool is_connected();
Christopher Haster 72:6a8b52ee83ed 56
Christopher Haster 72:6a8b52ee83ed 57 /** Send data to the remote host
Christopher Haster 89:b1d417383c0d 58 * @param data The buffer to send to the host
Christopher Haster 89:b1d417383c0d 59 * @param size The length of the buffer to send
Christopher Haster 89:b1d417383c0d 60 * @return Number of written bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 61 */
Christopher Haster 72:6a8b52ee83ed 62 int send(const void *data, unsigned size);
Christopher Haster 72:6a8b52ee83ed 63
Christopher Haster 72:6a8b52ee83ed 64 /** Receive data from the remote host
Christopher Haster 89:b1d417383c0d 65 * @param data The buffer in which to store the data received from the host
Christopher Haster 89:b1d417383c0d 66 * @param size The maximum length of the buffer
Christopher Haster 89:b1d417383c0d 67 * @return Number of received bytes on success, negative on failure
Christopher Haster 89:b1d417383c0d 68 */
Christopher Haster 73:968f7b32278f 69 int recv(void *data, unsigned size);
Christopher Haster 73:968f7b32278f 70
Christopher Haster 73:968f7b32278f 71 /** Register a callback on when send is ready
Christopher Haster 89:b1d417383c0d 72 * @param callback Function to call when send will succeed, may be called in
Christopher Haster 89:b1d417383c0d 73 * interrupt context.
Christopher Haster 89:b1d417383c0d 74 */
Christopher Haster 89:b1d417383c0d 75 void attach_send(FunctionPointer callback);
Christopher Haster 73:968f7b32278f 76
Christopher Haster 81:1600369a29dd 77 template <typename T, typename M>
Christopher Haster 81:1600369a29dd 78 void attach_send(T *tptr, M mptr) {
Christopher Haster 89:b1d417383c0d 79 attach_send(FunctionPointer(tptr, mptr));
Christopher Haster 81:1600369a29dd 80 }
Christopher Haster 81:1600369a29dd 81
Christopher Haster 73:968f7b32278f 82 /** Register a callback on when recv is ready
Christopher Haster 89:b1d417383c0d 83 * @param callback Function to call when recv will succeed, may be called in
Christopher Haster 89:b1d417383c0d 84 * interrupt context.
Christopher Haster 89:b1d417383c0d 85 */
Christopher Haster 89:b1d417383c0d 86 void attach_recv(FunctionPointer callback);
Christopher Haster 79:43a7e8c0d6cc 87
Christopher Haster 81:1600369a29dd 88 template <typename T, typename M>
Christopher Haster 81:1600369a29dd 89 void attach_recv(T *tptr, M mptr) {
Christopher Haster 89:b1d417383c0d 90 attach_recv(FunctionPointer(tptr, mptr));
Christopher Haster 81:1600369a29dd 91 }
Christopher Haster 81:1600369a29dd 92
Christopher Haster 79:43a7e8c0d6cc 93 private:
Christopher Haster 79:43a7e8c0d6cc 94 friend class TCPServer;
Christopher Haster 81:1600369a29dd 95
Christopher Haster 89:b1d417383c0d 96 FunctionPointer _send_cb;
Christopher Haster 89:b1d417383c0d 97 FunctionPointer _recv_cb;
Christopher Haster 72:6a8b52ee83ed 98 };
Christopher Haster 72:6a8b52ee83ed 99
Christopher Haster 72:6a8b52ee83ed 100 #endif