DongEun Koak / NetworkSocketAPI

NetworkSocketAPI

Dependencies:   DnsQuery

Dependents:   HelloWizFi250Interface

Fork of NetworkSocketAPI by NetworkSocketAPI

SocketInterface.h@28:163fbe3263f4, 2016-02-18 (annotated)

Committer:
Christopher Haster
Date:
Thu Feb 18 13:19:47 2016 -0600
Branch:
api-changes
Revision:
28:163fbe3263f4
Parent:
27:d7ed39727306
Child:
31:7f15b95f2a1d
Removed memory allocations for internal buffers

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 */
sam_grove 8:4b7f97a5597b 25 typedef enum {
sam_grove 8:4b7f97a5597b 26 SOCK_TCP, /*!< Socket connection over TCP */
sam_grove 8:4b7f97a5597b 27 SOCK_UDP, /*!< Socket connection over UDP */
sam_grove 8:4b7f97a5597b 28 } socket_protocol_t;
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 24:a5e959bdd2dd 39 /** Set the URL of the socket
Christopher Haster 24:a5e959bdd2dd 40 * Performs DNS lookup if necessary
Christopher Haster 24:a5e959bdd2dd 41 * @param url URL to connect to
Christopher Haster 27:d7ed39727306 42 * @return 0 on success
Christopher Haster 24:a5e959bdd2dd 43 */
Christopher Haster 27:d7ed39727306 44 virtual int32_t setURL(const char *url) = 0;
Christopher Haster 24:a5e959bdd2dd 45
Christopher Haster 21:35ed15069189 46 /** Set the IP address of the socket
Christopher Haster 21:35ed15069189 47 * @param ip IP address to connect to, copied internally
sam_grove 8:4b7f97a5597b 48 */
Christopher Haster 21:35ed15069189 49 virtual void setIPAddress(const char *ip);
sam_grove 16:658d4943c753 50
Christopher Haster 21:35ed15069189 51 /** Set the port of the socket
Christopher Haster 21:35ed15069189 52 * @param port Port to connect to
sam_grove 8:4b7f97a5597b 53 */
Christopher Haster 21:35ed15069189 54 virtual void setPort(uint16_t port);
sam_grove 8:4b7f97a5597b 55
Christopher Haster 21:35ed15069189 56 /** Open a connection to the underlying address
Christopher Haster 21:35ed15069189 57 * Only used for TCP sockets
Christopher Haster 21:35ed15069189 58 * @return 0 on success
sam_grove 8:4b7f97a5597b 59 */
Christopher Haster 21:35ed15069189 60 virtual int32_t open() = 0;
Christopher Haster 21:35ed15069189 61
Christopher Haster 21:35ed15069189 62 /** Close an open connection
Christopher Haster 21:35ed15069189 63 * Only used for TCP sockets
Christopher Haster 21:35ed15069189 64 * @return 0 on success
Christopher Haster 21:35ed15069189 65 */
Christopher Haster 21:35ed15069189 66 virtual int32_t close() = 0;
sam_grove 8:4b7f97a5597b 67
Christopher Haster 21:35ed15069189 68 /** Send data
Christopher Haster 21:35ed15069189 69 * @param data Buffer of data to send
Christopher Haster 21:35ed15069189 70 * @param len Size of data to send
Christopher Haster 21:35ed15069189 71 * @param timeout_ms Maximum amount of time to wait
Christopher Haster 21:35ed15069189 72 * @return 0 on success
sam_grove 8:4b7f97a5597b 73 */
Christopher Haster 22:4fca633c0633 74 virtual int32_t send(const void *data, uint32_t len, uint32_t timeout_ms) = 0;
sam_grove 8:4b7f97a5597b 75
Christopher Haster 21:35ed15069189 76 /** In client or server mode receive data
Christopher Haster 21:35ed15069189 77 * @param data a buffer to store the data in
Christopher Haster 21:35ed15069189 78 * @param amount The amount of data to receive
Christopher Haster 21:35ed15069189 79 * @param timeout_ms The longest time to wait for the data
Christopher Haster 21:35ed15069189 80 * @return Number of bytes sent or a negative value on failure
sam_grove 8:4b7f97a5597b 81 */
Christopher Haster 22:4fca633c0633 82 virtual int32_t recv(void *data, uint32_t len, uint32_t timeout_ms) = 0;
sam_grove 8:4b7f97a5597b 83 };
sam_grove 8:4b7f97a5597b 84
bridadan 1:291a9d61e58a 85 #endif