Mbed OS 文档翻译 之 参考(API(网络套接字(TCPSocket)))

ARM 42浏览

TCPSocket

                                                                                     

                                                                             TCPSocket 类层次结构

TCPSocket 类提供通过 TCP 发送数据流的能力。TCPSockets 维护一个以 connect 成员函数开始的有状态连接。成功连接到服务器后,您可以使用 send 和 recv 成员函数来发送和接收数据(类似于从文件写入或读取)。

构造函数接受 NetworkStack 指针以打开指定 NetworkInterface 上的套接字。如果你没有传入构造函数,那么你必须调用 open 来初始化套接字。

有关 TCP 服务器功能,请参阅 TCPServer 类。

TCPSocket 类参考

TCPSocket 类参考

公共成员函数
  TCPSocket ()
template<typename S >
  TCPSocket (S *stack)
virtual  ~TCPSocket ()
virtual int  join_multicast_group (const SocketAddress &address)
nsapi_error_t  connect (const char *host, uint16_t port)
virtual nsapi_error_t  connect (const SocketAddress &address)
virtual nsapi_size_or_error_t  send (const void *data, nsapi_size_t size)
virtual nsapi_size_or_error_t  recv (void *data, nsapi_size_t size)
virtual nsapi_size_or_error_t  sendto (const SocketAddress &address, const void *data, nsapi_size_t size)
virtual nsapi_size_or_error_t  recvfrom (SocketAddress *address, void *data, nsapi_size_t size)
virtual TCPSocket accept (nsapi_error_t *error=NULL)
virtual nsapi_error_t  listen (int backlog=1)
 公共成员函数继承自 InternetSocket
virtual  ~InternetSocket ()
nsapi_error_t  open (NetworkStack *stack)
template<typename S >
nsapi_error_t  open (S *stack)
virtual nsapi_error_t  close ()
int  join_multicast_group (const SocketAddress &address)
int  leave_multicast_group (const SocketAddress &address)
nsapi_error_t  bind (uint16_t port)
nsapi_error_t  bind (const char *address, uint16_t port)
virtual nsapi_error_t  bind (const SocketAddress &address)
virtual void  set_blocking (bool blocking)
virtual void  set_timeout (int timeout)
virtual nsapi_error_t  setsockopt (int level, int optname, const void *optval, unsigned optlen)
virtual nsapi_error_t  getsockopt (int level, int optname, void *optval, unsigned *optlen)
virtual void  sigio (mbed::Callback< void()> func)
void  attach (mbed::Callback< void()> func)
template<typename T , typename M >
void  attach (T *obj, M method)
 公共成员函数继承自 Socket
virtual  ~Socket ()
受保护的成员函数
virtual nsapi_protocol_t  get_proto ()
 受保护的成员函数继承自 InternetSocket
virtual void  event ()
int  modify_multicast_group (const SocketAddress &address, nsapi_socket_option_t socketopt)
友元
class  TCPServer
其他继承成员
 受保护的属性继承自 InternetSocket
NetworkStack _stack
nsapi_socket_t  _socket
uint32_t  _timeout
mbed::Callback< void()>  _event
mbed::Callback< void()>  _callback
rtos::EventFlags  _event_flag
rtos::Mutex  _lock
SocketAddress  _remote_peer
uint8_t  _readers
uint8_t  _writers
volatile unsigned  _pending
bool  _factory_allocated
 从中继承的静态保护属性 InternetSocket
static const int  READ_FLAG = 0x1u
static const int  WRITE_FLAG = 0x2u
static const int  FINISHED_FLAG = 0x3u

TCPSocket 示例

这是使用 ESP8266 模块的 HTTP 事务的 TCP 客户端示例。

main.cpp                                                                                                                                                 导入到 Mbed IDE

/* WiFi Example
 * Copyright (c) 2016 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.
 */

#include "mbed.h"
#include "TCPSocket.h"

#if TARGET_UBLOX_EVK_ODIN_W2
#include "OdinWiFiInterface.h"
OdinWiFiInterface wifi;
#else
#if !TARGET_FF_ARDUINO
#error [NOT_SUPPORTED] Only Arduino form factor devices are supported at this time
#endif
#include "ESP8266Interface.h"
ESP8266Interface wifi(D1, D0);
#endif

const char *sec2str(nsapi_security_t sec)
{
    switch (sec) {
        case NSAPI_SECURITY_NONE:
            return "None";
        case NSAPI_SECURITY_WEP:
            return "WEP";
        case NSAPI_SECURITY_WPA:
            return "WPA";
        case NSAPI_SECURITY_WPA2:
            return "WPA2";
        case NSAPI_SECURITY_WPA_WPA2:
            return "WPA/WPA2";
        case NSAPI_SECURITY_UNKNOWN:
        default:
            return "Unknown";
    }
}

void scan_demo(WiFiInterface *wifi)
{
    WiFiAccessPoint *ap;

    printf("Scan:rn");

    int count = wifi->scan(NULL,0);

    /* Limit number of network arbitrary to 15 */
    count = count < 15 ? count : 15;

    ap = new WiFiAccessPoint[count];
    count = wifi->scan(ap, count);
    for (int i = 0; i < count; i++)
    {
        printf("Network: %s secured: %s BSSID: %hhX:%hhX:%hhX:%hhx:%hhx:%hhx RSSI: %hhd Ch: %hhdrn", ap[i].get_ssid(),
               sec2str(ap[i].get_security()), ap[i].get_bssid()[0], ap[i].get_bssid()[1], ap[i].get_bssid()[2],
               ap[i].get_bssid()[3], ap[i].get_bssid()[4], ap[i].get_bssid()[5], ap[i].get_rssi(), ap[i].get_channel());
    }
    printf("%d networks available.rn", count);

    delete[] ap;
}

void http_demo(NetworkInterface *net)
{
    TCPSocket socket;

    printf("Sending HTTP request to www.arm.com...rn");

    // Open a socket on the network interface, and create a TCP connection to www.arm.com
    socket.open(net);
    socket.connect("www.arm.com", 80);

    // Send a simple http request
    char sbuffer[] = "GET / HTTP/1.1rnHost: www.arm.comrnrn";
    int scount = socket.send(sbuffer, sizeof sbuffer);
    printf("sent %d [%.*s]rn", scount, strstr(sbuffer, "rn")-sbuffer, sbuffer);

    // Recieve a simple http response and print out the response line
    char rbuffer[64];
    int rcount = socket.recv(rbuffer, sizeof rbuffer);
    printf("recv %d [%.*s]rn", rcount, strstr(rbuffer, "rn")-rbuffer, rbuffer);

    // Close the socket to return its memory and bring down the network interface
    socket.close();
}

int main()
{
    printf("WiFi examplernrn");

    scan_demo(&wifi);

    printf("rnConnecting...rn");
    int ret = wifi.connect(MBED_CONF_APP_WIFI_SSID, MBED_CONF_APP_WIFI_PASSWORD, NSAPI_SECURITY_WPA_WPA2);
    if (ret != 0) {
        printf("rnConnection errorrn");
        return -1;
    }

    printf("Successrnrn");
    printf("MAC: %srn", wifi.get_mac_address());
    printf("IP: %srn", wifi.get_ip_address());
    printf("Netmask: %srn", wifi.get_netmask());
    printf("Gateway: %srn", wifi.get_gateway());
    printf("RSSI: %drnrn", wifi.get_rssi());

    http_demo(&wifi);

    wifi.disconnect();

    printf("rnDonern");
}

以下是通过以太网接口进行 HTTP 事务的 TCP 客户端示例。

main.cpp                                                                                                                                              导入到 Mbed IDE

#include "mbed.h"
#include "EthernetInterface.h"

// Network interface
EthernetInterface net;

// Socket demo
int main() {
    // Bring up the ethernet interface
    printf("Ethernet socket examplen");
    net.connect();

    // Show the network address
    const char *ip = net.get_ip_address();
    printf("IP address is: %sn", ip ? ip : "No IP");

    // Open a socket on the network interface, and create a TCP connection to mbed.org
    TCPSocket socket;
    socket.open(&net);
    socket.connect("developer.mbed.org", 80);

    // Send a simple http request
    char sbuffer[] = "GET / HTTP/1.1rnHost: developer.mbed.orgrnrn";
    int scount = socket.send(sbuffer, sizeof sbuffer);
    printf("sent %d [%.*s]n", scount, strstr(sbuffer, "rn")-sbuffer, sbuffer);

    // Recieve a simple http response and print out the response line
    char rbuffer[64];
    int rcount = socket.recv(rbuffer, sizeof rbuffer);
    printf("recv %d [%.*s]n", rcount, strstr(rbuffer, "rn")-rbuffer, rbuffer);

    // Close the socket to return its memory and bring down the network interface
    socket.close();

    // Bring down the ethernet interface
    net.disconnect();
    printf("Donen");
}