Base class for IP Based Networking Libraries
Dependencies: DnsQuery
Dependents: TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more
For a complete getting started guide see the wiki...
Network Socket API
The Network Socket API provides a common interface for using sockets on network devices. The API provides a simple class-based interface that should be familiar to users experienced with other socket APIs. Additionally, the API provides a simple interface for implementing network devices, making it easy to connect hardware agnostic programs to new devices.
Network Interfaces
The NetworkInterface provides an abstract class for network devices that support sockets. Devices should provide a DeviceInterface class that inherits this interface and adds implementation specific methods for using the device. A NetworkInterface must be provided to a Socket constructor to open a socket on the interface. Currently two subclasses are defined for common devices, EthernetInterface
and WiFiInterface.
Sockets
The Socket class is used for managing network sockets. Once opened, the socket provides a pipe through which data can sent and recieved to a specific endpoint. The socket class can be instantiated as either a TCPSocket
or a UDPSocket
which defines the protocol used for the connection.
TCPSocket.h@89:b1d417383c0d, 2016-04-19 (annotated)
- Committer:
- Christopher Haster
- Date:
- Tue Apr 19 18:20:38 2016 -0500
- Revision:
- 89:b1d417383c0d
- Parent:
- 81:1600369a29dd
- Child:
- 90:0a988e4abb72
Adopt mbed style doxygen comments
Who changed what in which revision?
User | Revision | Line number | New 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 |
77:b66a6984ed2d | 29 | TCPSocket(NetworkInterface *iface); |
Christopher Haster |
81:1600369a29dd | 30 | virtual ~TCPSocket(); |
Christopher Haster |
72:6a8b52ee83ed | 31 | |
Christopher Haster |
72:6a8b52ee83ed | 32 | /** Connects this TCP socket to the server |
Christopher Haster |
89:b1d417383c0d | 33 | * @param host The host to connect to. It can either be an IP Address |
Christopher Haster |
89:b1d417383c0d | 34 | * or a hostname that will be resolved with DNS |
Christopher Haster |
89:b1d417383c0d | 35 | * @param port The host's port to connect to |
Christopher Haster |
89:b1d417383c0d | 36 | * @return 0 on success, negative on failure |
Christopher Haster |
89:b1d417383c0d | 37 | */ |
Christopher Haster |
79:43a7e8c0d6cc | 38 | int connect(const char *host, uint16_t port); |
Christopher Haster |
75:dea0cdb42241 | 39 | |
Christopher Haster |
75:dea0cdb42241 | 40 | /** Connects this TCP socket to the server |
Christopher Haster |
89:b1d417383c0d | 41 | * @param address SocketAddress to connect to |
Christopher Haster |
89:b1d417383c0d | 42 | * @return 0 on success, negative on failure |
Christopher Haster |
89:b1d417383c0d | 43 | */ |
Christopher Haster |
80:9c6673c93082 | 44 | int connect(const SocketAddress &address); |
Christopher Haster |
72:6a8b52ee83ed | 45 | |
Christopher Haster |
72:6a8b52ee83ed | 46 | /** Check if the socket is connected |
Christopher Haster |
89:b1d417383c0d | 47 | * @return true if connected, false otherwise |
Christopher Haster |
89:b1d417383c0d | 48 | */ |
Christopher Haster |
76:bbe51641f405 | 49 | bool is_connected(); |
Christopher Haster |
72:6a8b52ee83ed | 50 | |
Christopher Haster |
72:6a8b52ee83ed | 51 | /** Send data to the remote host |
Christopher Haster |
89:b1d417383c0d | 52 | * @param data The buffer to send to the host |
Christopher Haster |
89:b1d417383c0d | 53 | * @param size The length of the buffer to send |
Christopher Haster |
89:b1d417383c0d | 54 | * @return Number of written bytes on success, negative on failure |
Christopher Haster |
89:b1d417383c0d | 55 | */ |
Christopher Haster |
72:6a8b52ee83ed | 56 | int send(const void *data, unsigned size); |
Christopher Haster |
72:6a8b52ee83ed | 57 | |
Christopher Haster |
72:6a8b52ee83ed | 58 | /** Receive data from the remote host |
Christopher Haster |
89:b1d417383c0d | 59 | * @param data The buffer in which to store the data received from the host |
Christopher Haster |
89:b1d417383c0d | 60 | * @param size The maximum length of the buffer |
Christopher Haster |
89:b1d417383c0d | 61 | * @return Number of received bytes on success, negative on failure |
Christopher Haster |
89:b1d417383c0d | 62 | */ |
Christopher Haster |
73:968f7b32278f | 63 | int recv(void *data, unsigned size); |
Christopher Haster |
73:968f7b32278f | 64 | |
Christopher Haster |
73:968f7b32278f | 65 | /** Register a callback on when send is ready |
Christopher Haster |
89:b1d417383c0d | 66 | * @param callback Function to call when send will succeed, may be called in |
Christopher Haster |
89:b1d417383c0d | 67 | * interrupt context. |
Christopher Haster |
89:b1d417383c0d | 68 | */ |
Christopher Haster |
89:b1d417383c0d | 69 | void attach_send(FunctionPointer callback); |
Christopher Haster |
73:968f7b32278f | 70 | |
Christopher Haster |
81:1600369a29dd | 71 | template <typename T, typename M> |
Christopher Haster |
81:1600369a29dd | 72 | void attach_send(T *tptr, M mptr) { |
Christopher Haster |
89:b1d417383c0d | 73 | attach_send(FunctionPointer(tptr, mptr)); |
Christopher Haster |
81:1600369a29dd | 74 | } |
Christopher Haster |
81:1600369a29dd | 75 | |
Christopher Haster |
73:968f7b32278f | 76 | /** Register a callback on when recv is ready |
Christopher Haster |
89:b1d417383c0d | 77 | * @param callback Function to call when recv will succeed, may be called in |
Christopher Haster |
89:b1d417383c0d | 78 | * interrupt context. |
Christopher Haster |
89:b1d417383c0d | 79 | */ |
Christopher Haster |
89:b1d417383c0d | 80 | void attach_recv(FunctionPointer callback); |
Christopher Haster |
79:43a7e8c0d6cc | 81 | |
Christopher Haster |
81:1600369a29dd | 82 | template <typename T, typename M> |
Christopher Haster |
81:1600369a29dd | 83 | void attach_recv(T *tptr, M mptr) { |
Christopher Haster |
89:b1d417383c0d | 84 | attach_recv(FunctionPointer(tptr, mptr)); |
Christopher Haster |
81:1600369a29dd | 85 | } |
Christopher Haster |
81:1600369a29dd | 86 | |
Christopher Haster |
79:43a7e8c0d6cc | 87 | private: |
Christopher Haster |
79:43a7e8c0d6cc | 88 | friend class TCPServer; |
Christopher Haster |
81:1600369a29dd | 89 | |
Christopher Haster |
89:b1d417383c0d | 90 | FunctionPointer _send_cb; |
Christopher Haster |
89:b1d417383c0d | 91 | FunctionPointer _recv_cb; |
Christopher Haster |
72:6a8b52ee83ed | 92 | }; |
Christopher Haster |
72:6a8b52ee83ed | 93 | |
Christopher Haster |
72:6a8b52ee83ed | 94 | #endif |