mbed TLS v2.11.0
net_sockets.h
Go to the documentation of this file.
1 
6 /*
7  * Copyright (C) 2006-2015, ARM Limited, All Rights Reserved
8  * SPDX-License-Identifier: Apache-2.0
9  *
10  * Licensed under the Apache License, Version 2.0 (the "License"); you may
11  * not use this file except in compliance with the License.
12  * You may obtain a copy of the License at
13  *
14  * http://www.apache.org/licenses/LICENSE-2.0
15  *
16  * Unless required by applicable law or agreed to in writing, software
17  * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
18  * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
19  * See the License for the specific language governing permissions and
20  * limitations under the License.
21  *
22  * This file is part of mbed TLS (https://tls.mbed.org)
23  */
24 #ifndef MBEDTLS_NET_SOCKETS_H
25 #define MBEDTLS_NET_SOCKETS_H
26 
27 #if !defined(MBEDTLS_CONFIG_FILE)
28 #include "config.h"
29 #else
30 #include MBEDTLS_CONFIG_FILE
31 #endif
32 
33 #include "ssl.h"
34 
35 #include <stddef.h>
36 #include <stdint.h>
37 
38 #define MBEDTLS_ERR_NET_SOCKET_FAILED -0x0042
39 #define MBEDTLS_ERR_NET_CONNECT_FAILED -0x0044
40 #define MBEDTLS_ERR_NET_BIND_FAILED -0x0046
41 #define MBEDTLS_ERR_NET_LISTEN_FAILED -0x0048
42 #define MBEDTLS_ERR_NET_ACCEPT_FAILED -0x004A
43 #define MBEDTLS_ERR_NET_RECV_FAILED -0x004C
44 #define MBEDTLS_ERR_NET_SEND_FAILED -0x004E
45 #define MBEDTLS_ERR_NET_CONN_RESET -0x0050
46 #define MBEDTLS_ERR_NET_UNKNOWN_HOST -0x0052
47 #define MBEDTLS_ERR_NET_BUFFER_TOO_SMALL -0x0043
48 #define MBEDTLS_ERR_NET_INVALID_CONTEXT -0x0045
49 #define MBEDTLS_ERR_NET_POLL_FAILED -0x0047
50 #define MBEDTLS_ERR_NET_BAD_INPUT_DATA -0x0049
52 #define MBEDTLS_NET_LISTEN_BACKLOG 10
54 #define MBEDTLS_NET_PROTO_TCP 0
55 #define MBEDTLS_NET_PROTO_UDP 1
57 #define MBEDTLS_NET_POLL_READ 1
58 #define MBEDTLS_NET_POLL_WRITE 2
60 #ifdef __cplusplus
61 extern "C" {
62 #endif
63 
71 typedef struct
72 {
73  int fd;
74 }
76 
84 
100 int mbedtls_net_connect( mbedtls_net_context *ctx, const char *host, const char *port, int proto );
101 
119 int mbedtls_net_bind( mbedtls_net_context *ctx, const char *bind_ip, const char *port, int proto );
120 
138  mbedtls_net_context *client_ctx,
139  void *client_ip, size_t buf_size, size_t *ip_len );
140 
162 int mbedtls_net_poll( mbedtls_net_context *ctx, uint32_t rw, uint32_t timeout );
163 
172 
181 
190 void mbedtls_net_usleep( unsigned long usec );
191 
204 int mbedtls_net_recv( void *ctx, unsigned char *buf, size_t len );
205 
218 int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len );
219 
241 int mbedtls_net_recv_timeout( void *ctx, unsigned char *buf, size_t len,
242  uint32_t timeout );
243 
250 
251 #ifdef __cplusplus
252 }
253 #endif
254 
255 #endif /* net_sockets.h */
int mbedtls_net_bind(mbedtls_net_context *ctx, const char *bind_ip, const char *port, int proto)
Create a receiving socket on bind_ip:port in the chosen protocol. If bind_ip == NULL, all interfaces are bound.
void mbedtls_net_free(mbedtls_net_context *ctx)
Gracefully shutdown the connection and free associated data.
int mbedtls_net_accept(mbedtls_net_context *bind_ctx, mbedtls_net_context *client_ctx, void *client_ip, size_t buf_size, size_t *ip_len)
Accept a connection from a remote client.
int mbedtls_net_set_block(mbedtls_net_context *ctx)
Set the socket blocking.
int mbedtls_net_connect(mbedtls_net_context *ctx, const char *host, const char *port, int proto)
Initiate a connection with host:port in the given protocol.
Configuration options (set of defines)
void mbedtls_net_usleep(unsigned long usec)
Portable usleep helper.
int mbedtls_net_poll(mbedtls_net_context *ctx, uint32_t rw, uint32_t timeout)
Check and wait for the context to be ready for read/write.
int mbedtls_net_send(void *ctx, const unsigned char *buf, size_t len)
Write at most &#39;len&#39; characters. If no error occurs, the actual amount read is returned.
void mbedtls_net_init(mbedtls_net_context *ctx)
Initialize a context Just makes the context ready to be used or freed safely.
SSL/TLS functions.
int mbedtls_net_set_nonblock(mbedtls_net_context *ctx)
Set the socket non-blocking.
int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len, uint32_t timeout)
Read at most &#39;len&#39; characters, blocking for at most &#39;timeout&#39; seconds. If no error occurs...
int mbedtls_net_recv(void *ctx, unsigned char *buf, size_t len)
Read at most &#39;len&#39; characters. If no error occurs, the actual amount read is returned.