libcoap  4.3.0rc1
coap_io.h File Reference
#include <sys/types.h>
#include "coap2/address.h"
+ Include dependency graph for coap_io.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

struct  coap_addr_hash_t
 Only used for servers for hashing incoming packets. More...
 
struct  coap_addr_tuple_t
 
struct  coap_socket_t
 
struct  coap_packet_t
 

Macros

#define COAP_RXBUFFER_SIZE   1472
 
#define COAP_MAX_EPOLL_EVENTS   10
 
#define coap_closesocket   close
 
#define COAP_SOCKET_ERROR   (-1)
 
#define COAP_INVALID_SOCKET   (-1)
 
#define COAP_SOCKET_EMPTY   0x0000
 coap_socket_flags_t values More...
 
#define COAP_SOCKET_NOT_EMPTY   0x0001
 the socket is not empty More...
 
#define COAP_SOCKET_BOUND   0x0002
 the socket is bound More...
 
#define COAP_SOCKET_CONNECTED   0x0004
 the socket is connected More...
 
#define COAP_SOCKET_WANT_READ   0x0010
 non blocking socket is waiting for reading More...
 
#define COAP_SOCKET_WANT_WRITE   0x0020
 non blocking socket is waiting for writing More...
 
#define COAP_SOCKET_WANT_ACCEPT   0x0040
 non blocking server socket is waiting for accept More...
 
#define COAP_SOCKET_WANT_CONNECT   0x0080
 non blocking client socket is waiting for connect More...
 
#define COAP_SOCKET_CAN_READ   0x0100
 non blocking socket can now read without blocking More...
 
#define COAP_SOCKET_CAN_WRITE   0x0200
 non blocking socket can now write without blocking More...
 
#define COAP_SOCKET_CAN_ACCEPT   0x0400
 non blocking server socket can now accept without blocking More...
 
#define COAP_SOCKET_CAN_CONNECT   0x0800
 non blocking client socket can now connect without blocking More...
 
#define COAP_SOCKET_MULTICAST   0x1000
 socket is used for multicast communication More...
 
#define coap_mcast_interface(Local)   0
 

Typedefs

typedef int coap_fd_t
 
typedef uint16_t coap_socket_flags_t
 
typedef struct coap_addr_hash_t coap_addr_hash_t
 Only used for servers for hashing incoming packets. More...
 
typedef struct coap_addr_tuple_t coap_addr_tuple_t
 
typedef struct coap_socket_t coap_socket_t
 
typedef struct coap_packet_t coap_packet_t
 

Enumerations

enum  coap_nack_reason_t {
  COAP_NACK_TOO_MANY_RETRIES , COAP_NACK_NOT_DELIVERABLE , COAP_NACK_RST , COAP_NACK_TLS_FAILED ,
  COAP_NACK_ICMP_ISSUE
}
 

Functions

coap_endpoint_tcoap_malloc_endpoint (void)
 
void coap_mfree_endpoint (coap_endpoint_t *ep)
 
int coap_socket_connect_udp (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)
 
int coap_socket_bind_udp (coap_socket_t *sock, const coap_address_t *listen_addr, coap_address_t *bound_addr)
 
void coap_socket_close (coap_socket_t *sock)
 
ssize_t coap_socket_send (coap_socket_t *sock, struct coap_session_t *session, const uint8_t *data, size_t data_len)
 
ssize_t coap_socket_write (coap_socket_t *sock, const uint8_t *data, size_t data_len)
 
ssize_t coap_socket_read (coap_socket_t *sock, uint8_t *data, size_t data_len)
 
void coap_epoll_ctl_mod (coap_socket_t *sock, uint32_t events, const char *func)
 
const char * coap_socket_strerror (void)
 
const char * coap_socket_format_errno (int error)
 
int coap_tcp_is_supported (void)
 Check whether TCP is available. More...
 
ssize_t coap_network_send (coap_socket_t *sock, const struct coap_session_t *session, const uint8_t *data, size_t datalen)
 Function interface for data transmission. More...
 
ssize_t coap_network_read (coap_socket_t *sock, struct coap_packet_t *packet)
 Function interface for reading data. More...
 
void coap_packet_get_memmapped (struct coap_packet_t *packet, unsigned char **address, size_t *length)
 Given a packet, set msg and msg_len to an address and length of the packet's data in memory. More...
 

Macro Definition Documentation

◆ coap_closesocket

#define coap_closesocket   close

Definition at line 41 of file coap_io.h.

◆ COAP_INVALID_SOCKET

#define COAP_INVALID_SOCKET   (-1)

Definition at line 43 of file coap_io.h.

◆ COAP_MAX_EPOLL_EVENTS

#define COAP_MAX_EPOLL_EVENTS   10

Definition at line 31 of file coap_io.h.

◆ coap_mcast_interface

#define coap_mcast_interface (   Local)    0

Definition at line 178 of file coap_io.h.

◆ COAP_RXBUFFER_SIZE

#define COAP_RXBUFFER_SIZE   1472

Definition at line 22 of file coap_io.h.

◆ COAP_SOCKET_BOUND

#define COAP_SOCKET_BOUND   0x0002

the socket is bound

Definition at line 90 of file coap_io.h.

◆ COAP_SOCKET_CAN_ACCEPT

#define COAP_SOCKET_CAN_ACCEPT   0x0400

non blocking server socket can now accept without blocking

Definition at line 98 of file coap_io.h.

◆ COAP_SOCKET_CAN_CONNECT

#define COAP_SOCKET_CAN_CONNECT   0x0800

non blocking client socket can now connect without blocking

Definition at line 99 of file coap_io.h.

◆ COAP_SOCKET_CAN_READ

#define COAP_SOCKET_CAN_READ   0x0100

non blocking socket can now read without blocking

Definition at line 96 of file coap_io.h.

◆ COAP_SOCKET_CAN_WRITE

#define COAP_SOCKET_CAN_WRITE   0x0200

non blocking socket can now write without blocking

Definition at line 97 of file coap_io.h.

◆ COAP_SOCKET_CONNECTED

#define COAP_SOCKET_CONNECTED   0x0004

the socket is connected

Definition at line 91 of file coap_io.h.

◆ COAP_SOCKET_EMPTY

#define COAP_SOCKET_EMPTY   0x0000

coap_socket_flags_t values

the socket is not used

Definition at line 88 of file coap_io.h.

◆ COAP_SOCKET_ERROR

#define COAP_SOCKET_ERROR   (-1)

Definition at line 42 of file coap_io.h.

◆ COAP_SOCKET_MULTICAST

#define COAP_SOCKET_MULTICAST   0x1000

socket is used for multicast communication

Definition at line 100 of file coap_io.h.

◆ COAP_SOCKET_NOT_EMPTY

#define COAP_SOCKET_NOT_EMPTY   0x0001

the socket is not empty

Definition at line 89 of file coap_io.h.

◆ COAP_SOCKET_WANT_ACCEPT

#define COAP_SOCKET_WANT_ACCEPT   0x0040

non blocking server socket is waiting for accept

Definition at line 94 of file coap_io.h.

◆ COAP_SOCKET_WANT_CONNECT

#define COAP_SOCKET_WANT_CONNECT   0x0080

non blocking client socket is waiting for connect

Definition at line 95 of file coap_io.h.

◆ COAP_SOCKET_WANT_READ

#define COAP_SOCKET_WANT_READ   0x0010

non blocking socket is waiting for reading

Definition at line 92 of file coap_io.h.

◆ COAP_SOCKET_WANT_WRITE

#define COAP_SOCKET_WANT_WRITE   0x0020

non blocking socket is waiting for writing

Definition at line 93 of file coap_io.h.

Typedef Documentation

◆ coap_addr_hash_t

Only used for servers for hashing incoming packets.

Cannot have local address as this may be an initial multicast and subsequent unicast address

◆ coap_addr_tuple_t

◆ coap_fd_t

typedef int coap_fd_t

Definition at line 40 of file coap_io.h.

◆ coap_packet_t

typedef struct coap_packet_t coap_packet_t

Definition at line 185 of file coap_io.h.

◆ coap_socket_flags_t

typedef uint16_t coap_socket_flags_t

Definition at line 46 of file coap_io.h.

◆ coap_socket_t

typedef struct coap_socket_t coap_socket_t

Enumeration Type Documentation

◆ coap_nack_reason_t

Enumerator
COAP_NACK_TOO_MANY_RETRIES 
COAP_NACK_NOT_DELIVERABLE 
COAP_NACK_RST 
COAP_NACK_TLS_FAILED 
COAP_NACK_ICMP_ISSUE 

Definition at line 223 of file coap_io.h.

Function Documentation

◆ coap_epoll_ctl_mod()

void coap_epoll_ctl_mod ( coap_socket_t sock,
uint32_t  events,
const char *  func 
)
+ Here is the caller graph for this function:

◆ coap_malloc_endpoint()

coap_endpoint_t* coap_malloc_endpoint ( void  )

Definition at line 142 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_mfree_endpoint()

void coap_mfree_endpoint ( coap_endpoint_t ep)

Definition at line 147 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_network_read()

ssize_t coap_network_read ( coap_socket_t sock,
struct coap_packet_t packet 
)

Function interface for reading data.

This function returns the number of bytes that have been read, or a value less than zero on error. In case of an error, *packet is set to NULL.

Parameters
sockSocket to read data from
packetReceived packet metadata and payload. src and dst should be preset.
Returns
The number of bytes received on success, or a value less than zero on error.

Definition at line 746 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_network_send()

ssize_t coap_network_send ( coap_socket_t sock,
const struct coap_session_t session,
const uint8_t *  data,
size_t  datalen 
)

Function interface for data transmission.

This function returns the number of bytes that have been transmitted, or a value less than zero on error.

Parameters
sockSocket to send data with
sessionAddressing information for unconnected sockets, or NULL
dataThe data to send.
datalenThe actual length of data.
Returns
The number of bytes written on success, or a value less than zero on error.

◆ coap_packet_get_memmapped()

void coap_packet_get_memmapped ( struct coap_packet_t packet,
unsigned char **  address,
size_t *  length 
)

Given a packet, set msg and msg_len to an address and length of the packet's data in memory.

Definition at line 739 of file coap_io.c.

+ Here is the caller graph for this function:

◆ coap_socket_bind_udp()

int coap_socket_bind_udp ( coap_socket_t sock,
const coap_address_t listen_addr,
coap_address_t bound_addr 
)

Definition at line 152 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_close()

void coap_socket_close ( coap_socket_t sock)

Definition at line 362 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_connect_udp()

int coap_socket_connect_udp ( 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 
)

Definition at line 236 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_format_errno()

const char* coap_socket_format_errno ( int  error)

Definition at line 1485 of file coap_io.c.

+ Here is the caller graph for this function:

◆ coap_socket_read()

ssize_t coap_socket_read ( coap_socket_t sock,
uint8_t *  data,
size_t  data_len 
)

Definition at line 472 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_send()

ssize_t coap_socket_send ( coap_socket_t sock,
struct coap_session_t session,
const uint8_t *  data,
size_t  data_len 
)

Definition at line 1494 of file coap_io.c.

+ Here is the caller graph for this function:

◆ coap_socket_strerror()

const char* coap_socket_strerror ( void  )

Definition at line 1488 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_socket_write()

ssize_t coap_socket_write ( coap_socket_t sock,
const uint8_t *  data,
size_t  data_len 
)

Definition at line 421 of file coap_io.c.

+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ coap_tcp_is_supported()

int coap_tcp_is_supported ( void  )

Check whether TCP is available.

Returns
1 if support for TCP is enabled, or 0 otherwise.

Definition at line 31 of file coap_tcp.c.

+ Here is the caller graph for this function: