coap_proxy_internal.h

Go to the documentation of this file.

/*
 * coap_proxy_internal.h -- Proxy functions for libcoap
 *
 * Copyright (C) 2024-2025 Jon Shallow <supjps-libcoap@jpshallow.com>
 *
 * SPDX-License-Identifier: BSD-2-Clause
 *
 * This file is part of the CoAP library libcoap. Please see README for terms
 * of use.
 */
 
#ifndef COAP_PROXY_INTERNAL_H_
#define COAP_PROXY_INTERNAL_H_
 
#include "coap_internal.h"
 
typedef struct coap_proxy_req_t {
  coap_pdu_t *pdu;
  coap_resource_t *resource;
  coap_session_t *incoming;
  coap_bin_const_t *token_used;
  coap_cache_key_t *cache_key;
} coap_proxy_req_t;
 
struct coap_proxy_list_t {
  coap_session_t *ongoing;   
  coap_session_t *incoming;  
  coap_proxy_req_t *req_list; 
  size_t req_count;          
  coap_uri_t uri;            
  uint8_t *uri_host_keep;     
  coap_tick_t idle_timeout_ticks; 
  coap_tick_t last_used;     
};
 
void coap_proxy_cleanup(coap_context_t *context);
 
int coap_proxy_check_timeouts(coap_context_t *context, coap_tick_t now,
                              coap_tick_t *tim_rem);
 
int coap_proxy_remove_association(coap_session_t *session, int send_failure);
 
int coap_proxy_forward_request_lkd(coap_session_t *session,
                                   const coap_pdu_t *request,
                                   coap_pdu_t *response,
                                   coap_resource_t *resource,
                                   coap_cache_key_t *cache_key,
                                   coap_proxy_server_list_t *server_list);
 
coap_response_t coap_proxy_forward_response_lkd(coap_session_t *session,
                                                const coap_pdu_t *received,
                                                coap_cache_key_t **cache_key);
 
coap_session_t *coap_new_client_session_proxy_lkd(coap_context_t *context,
                                                  coap_proxy_server_list_t *server_list);
 
/*
 * coap_proxy_local_write() is used to send the PDU for a session created by
 * coap_new_client_session_proxy() into the proxy logic for onward transmittion.
 *
 * @param session The coap_new_client_session_proxy() generated session.
 * @param pdu The PDU presented to libcoap by coap_send().
 *
 * @return The MID used for the transmission, else COAP_INVALID_MID on failure.
 */
coap_mid_t coap_proxy_local_write(coap_session_t *session, coap_pdu_t *pdu);
 
/*
 * coap_proxy_map_outgoing_request() takes the upstream proxy client session and
 * maps it back to the incoming request.
 *
 * @param ongoing The upstream proxy client session.
 * @param received The received PDU from hte upstream server.
 * @param proxy_entry Updated with the proxy server entry definition if not NULL.
 *
 * @return The proxy request information, or NULL on mapping failure.
 */
struct coap_proxy_req_t *coap_proxy_map_outgoing_request(coap_session_t *ongoing,
                                                         const coap_pdu_t *received,
                                                         coap_proxy_list_t **proxy_entry);
#endif /* COAP_PROXY_INTERNAL_H_ */