coap_client_misc.h
Go to the documentation of this file.
1 /**
2  * @file coap_client_misc.h
3  * @brief Helper functions for CoAP client
4  *
5  * @section License
6  *
7  * SPDX-License-Identifier: GPL-2.0-or-later
8  *
9  * Copyright (C) 2010-2019 Oryx Embedded SARL. All rights reserved.
10  *
11  * This file is part of CycloneTCP Open.
12  *
13  * This program is free software; you can redistribute it and/or
14  * modify it under the terms of the GNU General Public License
15  * as published by the Free Software Foundation; either version 2
16  * of the License, or (at your option) any later version.
17  *
18  * This program is distributed in the hope that it will be useful,
19  * but WITHOUT ANY WARRANTY; without even the implied warranty of
20  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21  * GNU General Public License for more details.
22  *
23  * You should have received a copy of the GNU General Public License
24  * along with this program; if not, write to the Free Software Foundation,
25  * Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
26  *
27  * @author Oryx Embedded SARL (www.oryx-embedded.com)
28  * @version 1.9.6
29  **/
30 
31 #ifndef _COAP_CLIENT_MISC_H
32 #define _COAP_CLIENT_MISC_H
33 
34 //Dependencies
35 #include "core/net.h"
36 #include "coap/coap_client.h"
37 
38 //C++ guard
39 #ifdef __cplusplus
40 extern "C" {
41 #endif
42 
43 //CoAP client related functions
46 
48  CoapRequestState newState);
49 
51  const CoapMessage *response);
52 
54  const CoapMessage *response);
55 
57  const CoapMessage *response);
58 
61 
63  CoapMessageHeader *header);
64 
66  CoapMessageHeader *header);
67 
68 //C++ guard
69 #ifdef __cplusplus
70 }
71 #endif
72 
73 #endif
error_t coapClientProcessResponse(CoapClientRequest *request, const CoapMessage *response)
Process CoAP response.
#define CoapClientContext
Definition: coap_client.h:139
#define CoapClientRequest
Definition: coap_client.h:143
error_t coapClientRejectResponse(CoapClientContext *context, const CoapMessage *response)
Reject a CoAP response.
uint16_t mid
Definition: coap_common.h:182
error_t
Error codes.
Definition: error.h:42
CoAP message.
Definition: coap_message.h:55
__start_packed struct @106 CoapMessageHeader
CoAP message format.
CoAP client.
error_t coapClientMatchResponse(const CoapClientRequest *request, const CoapMessage *response)
Check whether a response matches the specified request.
void coapClientGenerateMessageId(CoapClientContext *context, CoapMessageHeader *header)
Generate a new message identifier.
error_t coapClientSendReset(CoapClientContext *context, uint16_t mid)
Send Reset message.
error_t coapClientProcessEvents(CoapClientContext *context, systime_t timeout)
Process CoAP client events.
error_t coapClientSendAck(CoapClientContext *context, uint16_t mid)
Send Acknowledgment message.
void coapClientGenerateToken(CoapClientContext *context, CoapMessageHeader *header)
Generate a new token.
error_t coapClientChangeRequestState(CoapClientRequest *request, CoapRequestState newState)
Update CoAP request state.
error_t coapClientProcessRequestEvents(CoapClientRequest *request)
Process request-specific events.
TCP/IP stack core.
uint32_t systime_t
Definition: compiler_port.h:46
CoapRequestState
CoAP request states.