NetworkSocketAPI / 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

Dependents:   TempTower BSDInterfaceTests HelloBSDInterface ESP8266InterfaceTests ... more

SocketInterface.h@42:49893d13c432, 2016-02-23 (annotated)

Committer:
Christopher Haster
Date:
Tue Feb 23 05:07:02 2016 -0600
Branch:
api-changes
Revision:
42:49893d13c432
Parent:
41:3ec1c97e9bbf
Child:
43:09ea32f2eb54
Standardized some C++ style things

Who changed what in which revision?

UserRevisionLine numberNew contents of line
sam_grove 0:d35446f60233 1 /* SocketInterface Base Class
sam_grove 0:d35446f60233 2 * Copyright (c) 2015 ARM Limited
sam_grove 0:d35446f60233 3 *
sam_grove 0:d35446f60233 4 * Licensed under the Apache License, Version 2.0 (the "License");
sam_grove 0:d35446f60233 5 * you may not use this file except in compliance with the License.
sam_grove 0:d35446f60233 6 * You may obtain a copy of the License at
sam_grove 0:d35446f60233 7 *
sam_grove 0:d35446f60233 8 * http://www.apache.org/licenses/LICENSE-2.0
sam_grove 0:d35446f60233 9 *
sam_grove 0:d35446f60233 10 * Unless required by applicable law or agreed to in writing, software
sam_grove 0:d35446f60233 11 * distributed under the License is distributed on an "AS IS" BASIS,
sam_grove 0:d35446f60233 12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
sam_grove 0:d35446f60233 13 * See the License for the specific language governing permissions and
sam_grove 0:d35446f60233 14 * limitations under the License.
sam_grove 0:d35446f60233 15 */
sam_grove 8:4b7f97a5597b 16
Christopher Haster 21:35ed15069189 17 #ifndef SOCKET_INTERFACE_H
Christopher Haster 21:35ed15069189 18 #define SOCKET_INTERFACE_H
bridadan 2:ce08986b18b5 19
sam_grove 8:4b7f97a5597b 20 #include "stdint.h"
sam_grove 8:4b7f97a5597b 21
sam_grove 8:4b7f97a5597b 22
Christopher Haster 21:35ed15069189 23 /** Enum of socket protocols
sam_grove 8:4b7f97a5597b 24 */
Christopher Haster 42:49893d13c432 25 enum socket_protocol_t {
sam_grove 8:4b7f97a5597b 26 SOCK_TCP, /*!< Socket connection over TCP */
sam_grove 8:4b7f97a5597b 27 SOCK_UDP, /*!< Socket connection over UDP */
Christopher Haster 42:49893d13c432 28 };
sam_grove 8:4b7f97a5597b 29
Christopher Haster 21:35ed15069189 30
Christopher Haster 21:35ed15069189 31 /** SocketInterface class
Christopher Haster 21:35ed15069189 32 * Common interface for implementation specific sockets created through
Christopher Haster 21:35ed15069189 33 * network interfaces. This class is used internally by the
Christopher Haster 21:35ed15069189 34 * TCPSocket and UDPSocket classes
sam_grove 8:4b7f97a5597b 35 */
Christopher Haster 21:35ed15069189 36 class SocketInterface
sam_grove 8:4b7f97a5597b 37 {
sam_grove 8:4b7f97a5597b 38 public:
Christopher Haster 21:35ed15069189 39 /** Set the IP address of the socket
Christopher Haster 41:3ec1c97e9bbf 40 * @param ip IP address to connect to
sam_grove 8:4b7f97a5597b 41 */
Christopher Haster 21:35ed15069189 42 virtual void setIPAddress(const char *ip);
sam_grove 16:658d4943c753 43
Christopher Haster 21:35ed15069189 44 /** Set the port of the socket
Christopher Haster 21:35ed15069189 45 * @param port Port to connect to
sam_grove 8:4b7f97a5597b 46 */
Christopher Haster 21:35ed15069189 47 virtual void setPort(uint16_t port);
sam_grove 8:4b7f97a5597b 48
Christopher Haster 41:3ec1c97e9bbf 49 /** Set a timeout on network operations
Christopher Haster 41:3ec1c97e9bbf 50 * @param timeout Maximum time in milliseconds for socket operations
Christopher Haster 41:3ec1c97e9bbf 51 */
Christopher Haster 41:3ec1c97e9bbf 52 virtual void setTimeout(uint32_t timeout);
Christopher Haster 41:3ec1c97e9bbf 53
Christopher Haster 38:157fb2ab965f 54 /** Status of the socket
Christopher Haster 38:157fb2ab965f 55 * @return True if connected
Christopher Haster 38:157fb2ab965f 56 */
Christopher Haster 38:157fb2ab965f 57 virtual bool isConnected();
Christopher Haster 38:157fb2ab965f 58
Christopher Haster 21:35ed15069189 59 /** Open a connection to the underlying address
Christopher Haster 36:eab792dfb0d8 60 * @param ip IP address to connect to
Christopher Haster 36:eab792dfb0d8 61 * @param port Port to connect to
Christopher Haster 21:35ed15069189 62 * @return 0 on success
sam_grove 8:4b7f97a5597b 63 */
Christopher Haster 36:eab792dfb0d8 64 virtual int32_t open(const char *ip, uint16_t port) = 0;
Christopher Haster 21:35ed15069189 65
Christopher Haster 21:35ed15069189 66 /** Close an open connection
Christopher Haster 21:35ed15069189 67 * @return 0 on success
Christopher Haster 21:35ed15069189 68 */
Christopher Haster 21:35ed15069189 69 virtual int32_t close() = 0;
sam_grove 8:4b7f97a5597b 70
Christopher Haster 21:35ed15069189 71 /** Send data
Christopher Haster 21:35ed15069189 72 * @param data Buffer of data to send
Christopher Haster 21:35ed15069189 73 * @param len Size of data to send
Christopher Haster 21:35ed15069189 74 * @return 0 on success
sam_grove 8:4b7f97a5597b 75 */
Christopher Haster 41:3ec1c97e9bbf 76 virtual int32_t send(const void *data, uint32_t len) = 0;
sam_grove 8:4b7f97a5597b 77
Christopher Haster 21:35ed15069189 78 /** In client or server mode receive data
Christopher Haster 21:35ed15069189 79 * @param data a buffer to store the data in
Christopher Haster 21:35ed15069189 80 * @param amount The amount of data to receive
Christopher Haster 21:35ed15069189 81 * @return Number of bytes sent or a negative value on failure
sam_grove 8:4b7f97a5597b 82 */
Christopher Haster 41:3ec1c97e9bbf 83 virtual int32_t recv(void *data, uint32_t len) = 0;
sam_grove 8:4b7f97a5597b 84 };
sam_grove 8:4b7f97a5597b 85
bridadan 1:291a9d61e58a 86 #endif