mbed TLS v2.28.0
net_sockets.h
Go to the documentation of this file.
1
22/*
23 * Copyright The Mbed TLS Contributors
24 * SPDX-License-Identifier: Apache-2.0
25 *
26 * Licensed under the Apache License, Version 2.0 (the "License"); you may
27 * not use this file except in compliance with the License.
28 * You may obtain a copy of the License at
29 *
30 * http://www.apache.org/licenses/LICENSE-2.0
31 *
32 * Unless required by applicable law or agreed to in writing, software
33 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
34 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
35 * See the License for the specific language governing permissions and
36 * limitations under the License.
37 */
38#ifndef MBEDTLS_NET_SOCKETS_H
39#define MBEDTLS_NET_SOCKETS_H
40
41#if !defined(MBEDTLS_CONFIG_FILE)
42#include "mbedtls/config.h"
43#else
44#include MBEDTLS_CONFIG_FILE
45#endif
46
47#include "mbedtls/ssl.h"
48
49#include <stddef.h>
50#include <stdint.h>
51
53#define MBEDTLS_ERR_NET_SOCKET_FAILED -0x0042
55#define MBEDTLS_ERR_NET_CONNECT_FAILED -0x0044
57#define MBEDTLS_ERR_NET_BIND_FAILED -0x0046
59#define MBEDTLS_ERR_NET_LISTEN_FAILED -0x0048
61#define MBEDTLS_ERR_NET_ACCEPT_FAILED -0x004A
63#define MBEDTLS_ERR_NET_RECV_FAILED -0x004C
65#define MBEDTLS_ERR_NET_SEND_FAILED -0x004E
67#define MBEDTLS_ERR_NET_CONN_RESET -0x0050
69#define MBEDTLS_ERR_NET_UNKNOWN_HOST -0x0052
71#define MBEDTLS_ERR_NET_BUFFER_TOO_SMALL -0x0043
73#define MBEDTLS_ERR_NET_INVALID_CONTEXT -0x0045
75#define MBEDTLS_ERR_NET_POLL_FAILED -0x0047
77#define MBEDTLS_ERR_NET_BAD_INPUT_DATA -0x0049
78
79#define MBEDTLS_NET_LISTEN_BACKLOG 10
81#define MBEDTLS_NET_PROTO_TCP 0
82#define MBEDTLS_NET_PROTO_UDP 1
84#define MBEDTLS_NET_POLL_READ 1
85#define MBEDTLS_NET_POLL_WRITE 2
87#ifdef __cplusplus
88extern "C" {
89#endif
90
98typedef struct mbedtls_net_context
99{
100 int fd;
101}
103
111
127int mbedtls_net_connect( mbedtls_net_context *ctx, const char *host, const char *port, int proto );
128
147int mbedtls_net_bind( mbedtls_net_context *ctx, const char *bind_ip, const char *port, int proto );
148
168 mbedtls_net_context *client_ctx,
169 void *client_ip, size_t buf_size, size_t *ip_len );
170
196int mbedtls_net_poll( mbedtls_net_context *ctx, uint32_t rw, uint32_t timeout );
197
206
215
224void mbedtls_net_usleep( unsigned long usec );
225
238int mbedtls_net_recv( void *ctx, unsigned char *buf, size_t len );
239
252int mbedtls_net_send( void *ctx, const unsigned char *buf, size_t len );
253
280int mbedtls_net_recv_timeout( void *ctx, unsigned char *buf, size_t len,
281 uint32_t timeout );
282
289
296
297#ifdef __cplusplus
298}
299#endif
300
301#endif /* net_sockets.h */
Configuration options (set of defines)
int mbedtls_net_recv(void *ctx, unsigned char *buf, size_t len)
Read at most 'len' characters. If no error occurs, the actual amount read is returned.
int mbedtls_net_set_nonblock(mbedtls_net_context *ctx)
Set the socket non-blocking.
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_send(void *ctx, const unsigned char *buf, size_t len)
Write at most 'len' characters. If no error occurs, the actual amount read is returned.
void mbedtls_net_close(mbedtls_net_context *ctx)
Closes down the connection and free associated data.
struct mbedtls_net_context mbedtls_net_context
int mbedtls_net_recv_timeout(void *ctx, unsigned char *buf, size_t len, uint32_t timeout)
Read at most 'len' characters, blocking for at most 'timeout' seconds. If no error occurs,...
void mbedtls_net_usleep(unsigned long usec)
Portable usleep helper.
void mbedtls_net_free(mbedtls_net_context *ctx)
Gracefully shutdown the connection and free associated data.
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,...
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_connect(mbedtls_net_context *ctx, const char *host, const char *port, int proto)
Initiate a connection with host:port in the given protocol.
void mbedtls_net_init(mbedtls_net_context *ctx)
Initialize a context Just makes the context ready to be used or freed safely.
int mbedtls_net_set_block(mbedtls_net_context *ctx)
Set the socket blocking.
SSL/TLS functions.