mirror of
https://github.com/obgm/libcoap.git
synced 2026-11-13 11:50:40 +03:00
Jon Shallow
152f6a8a58
Include common system header files in coap_internal.h based on HAVE_*H definitions. Remove these system header files from include/*/*.h. Add in system header files where appropriate in various apps.
150 lines
4.4 KiB
C
150 lines
4.4 KiB
C
/*
|
|
* coap_strm_internal.h -- Stream (TCP) functions for libcoap
|
|
*
|
|
* Copyright (C) 2019--2026 Olaf Bergmann <bergmann@tzi.org> and others
|
|
*
|
|
* SPDX-License-Identifier: BSD-2-Clause
|
|
*
|
|
* This file is part of the CoAP library libcoap. Please see README for terms
|
|
* of use.
|
|
*/
|
|
|
|
/**
|
|
* @file coap_strm_internal.h
|
|
* @brief CoAP Stream (TCP) internal information
|
|
*/
|
|
|
|
#ifndef COAP_STRM_INTERNAL_H_
|
|
#define COAP_STRM_INTERNAL_H_
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
/**
|
|
* @ingroup internal_api
|
|
* @defgroup strm Stream (TCP) Support
|
|
* Internal API for handling CoAP TCP (RFC8323)
|
|
* @{
|
|
*/
|
|
|
|
#if !COAP_DISABLE_TCP
|
|
|
|
/**
|
|
* Create a new TCP socket and initiate the connection.
|
|
*
|
|
* Internal function.
|
|
*
|
|
* @param sock Where socket information is to be filled in.
|
|
* @param local_if The local address to use or NULL.
|
|
* @param server The address to connect to.
|
|
* @param default_port The port to use if not set in @p server.
|
|
* @param local_addr Filled in after connection initiation with
|
|
* the local address.
|
|
* @param remote_addr Filled in after connection initiation with
|
|
* the remote address.
|
|
*
|
|
* @return @c 1 if succesful, @c 0 if failure of some sort.
|
|
*/
|
|
int coap_socket_connect_tcp1(coap_socket_t *sock,
|
|
const coap_address_t *local_if,
|
|
const coap_address_t *server,
|
|
int default_port,
|
|
coap_address_t *local_addr,
|
|
coap_address_t *remote_addr);
|
|
|
|
/**
|
|
* Complete the TCP Connection.
|
|
*
|
|
* Internal function.
|
|
*
|
|
* @param sock The socket information to use.
|
|
* @param local_addr Filled in with the final local address.
|
|
* @param remote_addr Filled in with the final remote address.
|
|
*
|
|
* @return @c 1 if succesful, @c 0 if failure of some sort.
|
|
*/
|
|
int coap_socket_connect_tcp2(coap_socket_t *sock,
|
|
coap_address_t *local_addr,
|
|
coap_address_t *remote_addr);
|
|
|
|
/**
|
|
* Create a new TCP socket and then listen for new incoming TCP sessions.
|
|
*
|
|
* Internal function.
|
|
*
|
|
* @param sock Where socket information is to be filled in.
|
|
* @param listen_addr The address to be listening for new incoming sessions.
|
|
* @param bound_addr Filled in with the address that the TCP layer
|
|
* is listening on for new incoming TCP sessions.
|
|
*
|
|
* @return @c 1 if succesful, @c 0 if failure of some sort.
|
|
*/
|
|
int coap_socket_bind_tcp(coap_socket_t *sock,
|
|
const coap_address_t *listen_addr,
|
|
coap_address_t *bound_addr);
|
|
|
|
/**
|
|
* Accept a new incoming TCP session.
|
|
*
|
|
* Internal function.
|
|
*
|
|
* @param server The socket information to use to accept the TCP connection.
|
|
* @param new_client Filled in socket information with the new incoming
|
|
* session information.
|
|
* @param local_addr Filled in with the local address.
|
|
* @param remote_addr Filled in with the remote address.
|
|
* @param extra Available for use by any underlying network stack.
|
|
*
|
|
* @return @c 1 if succesful, @c 0 if failure of some sort.
|
|
*/
|
|
int coap_socket_accept_tcp(coap_socket_t *server,
|
|
coap_socket_t *new_client,
|
|
coap_address_t *local_addr,
|
|
coap_address_t *remote_addr,
|
|
void *extra);
|
|
|
|
/**
|
|
* Function interface for data stream sending off a socket.
|
|
*
|
|
* @param sock Socket to send data over.
|
|
* @param data The data to send.
|
|
* @param data_len The length of @p data.
|
|
*
|
|
* @return >=0 Number of bytes sent.
|
|
* -1 Error error in errno.
|
|
*/
|
|
ssize_t coap_socket_write(coap_socket_t *sock, const uint8_t *data, size_t data_len);
|
|
|
|
/**
|
|
* Function interface for data stream receiving off a socket.
|
|
*
|
|
* @param sock Socket to receive data on.
|
|
* @param data The data to receive.
|
|
* @param data_len The maximum length of @p data.
|
|
*
|
|
* @return >=0 Number of bytes read.
|
|
* -1 Error error in errno.
|
|
*/
|
|
ssize_t coap_socket_read(coap_socket_t *sock, uint8_t *data, size_t data_len);
|
|
|
|
/**
|
|
* Function interface to close off a stream socket.
|
|
*
|
|
* Internal function.
|
|
*
|
|
* @param sock Socket to close.
|
|
*
|
|
*/
|
|
void coap_socket_strm_close(coap_socket_t *sock);
|
|
|
|
#endif /* !COAP_DISABLE_TCP */
|
|
|
|
/** @} */
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* COAP_STRM_INTERNAL_H_ */
|