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-05
Revision:
78:0914f9b9b24b
Parent:
77:b66a6984ed2d
Child:
79:43a7e8c0d6cc

File content as of revision 78:0914f9b9b24b:

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


/** Abstract socket class
 */
class Socket {
public:
    /** Socket lifetime
     */
    Socket();
    ~Socket();
    
    /** 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 int 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 int *optlen);
    
    /** Close the socket
    \param shutdown  free the left-over data in message queues
    */
    int close(bool shutdown=true);
};

#endif