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