sandbox / NetworkSocketAPI

Important changes to repositories hosted on mbed.com

Mbed hosted mercurial repositories are deprecated and are due to be permanently deleted in July 2026.

To keep a copy of this software download the repository Zip archive or clone locally using Mercurial.

It is also possible to export all your personal repositories from the account settings page.

Dependencies:   DnsQuery

Fork of NetworkSocketAPI by Christopher Haster

TCPSocket.h@6:0914f9b9b24b, 2016-04-05 (annotated)

Committer:
Christopher Haster
Date:
Tue Apr 05 09:20:32 2016 -0500
Revision:
6:0914f9b9b24b
Parent:
5:b66a6984ed2d
Child:
7:43a7e8c0d6cc
Dragged over license from nsapi

Who changed what in which revision?

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