ac74d8b652
Replace the existing Apache 2.0 boilerplate header with an SPDX tag throughout the zephyr code tree. This patch was generated via a script run over the master branch. Also updated doc/porting/application.rst that had a dependency on line numbers in a literal include. Manually updated subsys/logging/sys_log.c that had a malformed header in the original file. Also cleanup several cases that already had a SPDX tag and we either got a duplicate or missed updating. Jira: ZEP-1457 Change-Id: I6131a1d4ee0e58f5b938300c2d2fc77d2e69572c Signed-off-by: David B. Kinder <david.b.kinder@intel.com> Signed-off-by: Kumar Gala <kumar.gala@linaro.org>
153 lines
3.9 KiB
C
153 lines
3.9 KiB
C
/** @file
|
|
@brief Generic connection handling.
|
|
|
|
This is not to be included by the application.
|
|
*/
|
|
|
|
/*
|
|
* Copyright (c) 2016 Intel Corporation
|
|
*
|
|
* SPDX-License-Identifier: Apache-2.0
|
|
*/
|
|
|
|
#ifndef __CONNECTION_H
|
|
#define __CONNECTION_H
|
|
|
|
#include <stdint.h>
|
|
|
|
#include <misc/util.h>
|
|
|
|
#include <net/net_core.h>
|
|
#include <net/net_ip.h>
|
|
#include <net/nbuf.h>
|
|
|
|
#ifdef __cplusplus
|
|
extern "C" {
|
|
#endif
|
|
|
|
struct net_conn;
|
|
|
|
struct net_conn_handle;
|
|
|
|
/**
|
|
* @brief Function that is called by connection subsystem when UDP/TCP
|
|
* packet is received and which matches local and remote IP address
|
|
* and port.
|
|
*/
|
|
typedef enum net_verdict (*net_conn_cb_t)(struct net_conn *conn,
|
|
struct net_buf *buf,
|
|
void *user_data);
|
|
|
|
/**
|
|
* @brief Information about a connection in the system.
|
|
*
|
|
* Stores the connection information.
|
|
*
|
|
*/
|
|
struct net_conn {
|
|
/** Remote IP address */
|
|
struct sockaddr remote_addr;
|
|
|
|
/** Local IP address */
|
|
struct sockaddr local_addr;
|
|
|
|
/** Callback to be called when matching UDP packet is received */
|
|
net_conn_cb_t cb;
|
|
|
|
/** Possible user to pass to the callback */
|
|
void *user_data;
|
|
|
|
/** Connection protocol */
|
|
uint8_t proto;
|
|
|
|
/** Flags for the connection */
|
|
uint8_t flags;
|
|
|
|
/** Rank of this connection. Higher rank means more specific
|
|
* connection.
|
|
* Value is constructed like this:
|
|
* bit 0 local port, bit set if specific value
|
|
* bit 1 remote port, bit set if specific value
|
|
* bit 2 local address, bit set if unspecified address
|
|
* bit 3 remote address, bit set if unspecified address
|
|
* bit 4 local address, bit set if specific address
|
|
* bit 5 remote address, bit set if specific address
|
|
*/
|
|
uint8_t rank;
|
|
};
|
|
|
|
/**
|
|
* @brief Register a callback to be called when UDP/TCP packet
|
|
* is received corresponding to received packet.
|
|
*
|
|
* @param proto Protocol for the connection (UDP or TCP)
|
|
* @param remote_addr Remote address of the connection end point.
|
|
* @param local_addr Local address of the connection end point.
|
|
* @param remote_port Remote port of the connection end point.
|
|
* @param local_port Local port of the connection end point.
|
|
* @param cb Callback to be called
|
|
* @param user_data User data supplied by caller.
|
|
* @param handle Connection handle that can be used when unregistering
|
|
*
|
|
* @return Return 0 if the registration succeed, <0 otherwise.
|
|
*/
|
|
int net_conn_register(enum net_ip_protocol proto,
|
|
const struct sockaddr *remote_addr,
|
|
const struct sockaddr *local_addr,
|
|
uint16_t remote_port,
|
|
uint16_t local_port,
|
|
net_conn_cb_t cb,
|
|
void *user_data,
|
|
struct net_conn_handle **handle);
|
|
|
|
/**
|
|
* @brief Unregister connection handler.
|
|
*
|
|
* @param handle Handle from registering.
|
|
*
|
|
* @return Return 0 if the unregistration succeed, <0 otherwise.
|
|
*/
|
|
int net_conn_unregister(struct net_conn_handle *handle);
|
|
|
|
/**
|
|
* @brief Change the callback and user_data for a registered connection
|
|
* handle.
|
|
*
|
|
* @param handle A handle registered with net_conn_register()
|
|
* @param cb Callback to be called
|
|
* @param user_data User data supplied by caller.
|
|
*
|
|
* @return Return 0 if the the change succeed, <0 otherwise.
|
|
*/
|
|
int net_conn_change_callback(struct net_conn_handle *handle,
|
|
net_conn_cb_t cb, void *user_data);
|
|
|
|
/**
|
|
* @brief Called by net_core.c when a network packet is received.
|
|
*
|
|
* @param buf Network buffer holding received data
|
|
*
|
|
* @return NET_OK if the packet was consumed, NET_DROP if
|
|
* the packet parsing failed and the caller should handle
|
|
* the received packet. If corresponding IP protocol support is
|
|
* disabled, the function will always return NET_DROP.
|
|
*/
|
|
#if defined(CONFIG_NET_UDP) || defined(CONFIG_NET_TCP)
|
|
enum net_verdict net_conn_input(enum net_ip_protocol proto,
|
|
struct net_buf *buf);
|
|
#else
|
|
static inline enum net_verdict net_conn_input(enum net_ip_protocol proto,
|
|
struct net_buf *buf)
|
|
{
|
|
return NET_DROP;
|
|
}
|
|
#endif /* CONFIG_NET_UDP || CONFIG_NET_TCP */
|
|
|
|
void net_conn_init(void);
|
|
|
|
#ifdef __cplusplus
|
|
}
|
|
#endif
|
|
|
|
#endif /* __CONNECTION_H */
|