NetworkSocketAPI / NetworkSocketAPI

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.

Socket.h

Committer:
Christopher Haster
Date:
2016-04-19
Revision:
91:cad29ce6a01c
Parent:
90:0a988e4abb72
Child:
92:dd5f19874adf

File content as of revision 91:cad29ce6a01c:

/* Socket
 * Copyright (c) 2015 ARM Limited
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#ifndef SOCKET_H
#define SOCKET_H

#include "SocketAddress.h"
#include "NetworkInterface.h"

/** Abstract socket class
 */
class Socket {
public:
    /** Socket lifetime
     */
    virtual ~Socket();

    /** Open the socket
     *  @param iface    Interface to open socket on
     */
    virtual int open(NetworkInterface *iface) = 0;
    
    /** Set blocking or non-blocking mode of the socket
     *  @param blocking true for blocking mode, false for non-blocking mode.
     */
    void set_blocking(bool blocking);
    
    /** Set timeout on a socket operation if blocking behaviour is enabled
     *  @param timeout  timeout in ms
     */
    void set_timeout(unsigned int timeout);

    /*  Set socket options
     *  @param optname  Option ID
     *  @param optval   Option value
     *  @param optlen   Length of the option value
     *  @return         0 on success, negative on failure
     */
    int set_option(int optname, const void *optval, unsigned optlen);
    
    /*  Get socket options
     *  @param optname  Option ID
     *  @param optval   Buffer pointer where to write the option value
     *  @param optlen   Length of the option value
     *  @return         0 on success, negative on failure
     */
    int get_option(int optname, void *optval, unsigned *optlen);
    
    /** Close the socket
     */
    int close();

protected:
    Socket();
    int open(NetworkInterface *iface, nsapi_protocol_t proto);

    static void thunk(void *);

    NetworkInterface *_iface;
    void *_socket;
    bool _blocking;
    unsigned _timeout;
};

#endif