| /* |
| * Copyright (c) 2016, The OpenThread Authors. |
| * All rights reserved. |
| * |
| * Redistribution and use in source and binary forms, with or without |
| * modification, are permitted provided that the following conditions are met: |
| * 1. Redistributions of source code must retain the above copyright |
| * notice, this list of conditions and the following disclaimer. |
| * 2. Redistributions in binary form must reproduce the above copyright |
| * notice, this list of conditions and the following disclaimer in the |
| * documentation and/or other materials provided with the distribution. |
| * 3. Neither the name of the copyright holder nor the |
| * names of its contributors may be used to endorse or promote products |
| * derived from this software without specific prior written permission. |
| * |
| * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" |
| * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE |
| * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE |
| * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE |
| * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR |
| * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF |
| * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS |
| * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN |
| * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) |
| * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE |
| * POSSIBILITY OF SUCH DAMAGE. |
| */ |
| |
| /** |
| * @file |
| * This file includes definitions for the CoAP server. |
| */ |
| |
| #ifndef COAP_SERVER_HPP_ |
| #define COAP_SERVER_HPP_ |
| |
| #include <coap/coap_header.hpp> |
| #include <common/message.hpp> |
| #include <net/udp6.hpp> |
| |
| namespace Thread { |
| namespace Coap { |
| |
| /** |
| * @addtogroup core-coap |
| * |
| * @{ |
| * |
| */ |
| |
| /** |
| * This class implements CoAP resource handling. |
| * |
| */ |
| class Resource |
| { |
| friend class Server; |
| |
| public: |
| /** |
| * This function pointer is called when a CoAP message with a given Uri-Path is received. |
| * |
| * @param[in] aContext A pointer to arbitrary context information. |
| * @param[in] aHeader A reference to the CoAP header. |
| * @param[in] aMessage A reference to the message. |
| * @param[in] aMessageInfo A reference to the message info for @p aMessage. |
| * |
| */ |
| typedef void (*CoapMessageHandler)(void *aContext, Header &aHeader, Message &aMessage, |
| const Ip6::MessageInfo &aMessageInfo); |
| |
| /** |
| * This constructor initializes the resource. |
| * |
| * @param[in] aUriPath A pointer to a NULL-terminated string for the Uri-Path. |
| * @param[in] aHandler A function pointer that is called when receiving a CoAP message for @p aUriPath. |
| * @param[in] aContext A pointer to arbitrary context information. |
| */ |
| Resource(const char *aUriPath, CoapMessageHandler aHandler, void *aContext) { |
| mUriPath = aUriPath; |
| mHandler = aHandler; |
| mContext = aContext; |
| mNext = NULL; |
| } |
| |
| private: |
| void HandleRequest(Header &aHeader, Message &aMessage, const Ip6::MessageInfo &aMessageInfo) { |
| mHandler(mContext, aHeader, aMessage, aMessageInfo); |
| } |
| |
| const char *mUriPath; |
| CoapMessageHandler mHandler; |
| void *mContext; |
| Resource *mNext; |
| }; |
| |
| /** |
| * This class implements the CoAP server. |
| * |
| */ |
| class Server |
| { |
| public: |
| /** |
| * This constructor initializes the object. |
| * |
| * @param[in] aUdp A reference to the UDP object. |
| * @param[in] aPort The port to listen on. |
| * |
| */ |
| Server(Ip6::Udp &aUdp, uint16_t aPort); |
| |
| /** |
| * This method starts the CoAP server. |
| * |
| * @retval kThreadError_None Successfully started the CoAP server. |
| * |
| */ |
| ThreadError Start(); |
| |
| /** |
| * This method stops the CoAP server. |
| * |
| * @retval kThreadError_None Successfully stopped the CoAP server. |
| * |
| */ |
| ThreadError Stop(); |
| |
| /** |
| * This method adds a resource to the CoAP server. |
| * |
| * @param[in] aResource A reference to the resource. |
| * |
| * @retval kThreadError_None Successfully added @p aResource. |
| * @retval kThreadError_Busy The @p aResource was already added. |
| * |
| */ |
| ThreadError AddResource(Resource &aResource); |
| |
| /** |
| * This method returns a new UDP message with sufficient header space reserved. |
| * |
| * @param[in] aReserved The number of header bytes to reserve after the UDP header. |
| * |
| * @returns A pointer to the message or NULL if no buffers are available. |
| * |
| */ |
| Message *NewMessage(uint16_t aReserved); |
| |
| /** |
| * This method sends a CoAP response from the server. |
| * |
| * @param[in] aMessage The CoAP response to send. |
| * @param[in] aMessageInfo The message info corresponding to @p aMessage. |
| * |
| * @retval kThreadError_None Successfully enqueued the CoAP response message. |
| * @retval kThreadError_NoBufs Insufficient buffers available to send the CoAP response. |
| * |
| */ |
| ThreadError SendMessage(Message &aMessage, const Ip6::MessageInfo &aMessageInfo); |
| |
| private: |
| enum |
| { |
| kMaxReceivedUriPath = 32, ///< Maximum supported URI path on received messages. |
| }; |
| |
| static void HandleUdpReceive(void *aContext, otMessage aMessage, const otMessageInfo *aMessageInfo); |
| void HandleUdpReceive(Message &aMessage, const Ip6::MessageInfo &aMessageInfo); |
| |
| Ip6::UdpSocket mSocket; |
| uint16_t mPort; |
| Resource *mResources; |
| }; |
| |
| /** |
| * @} |
| * |
| */ |
| |
| } // namespace Coap |
| } // namespace Thread |
| |
| #endif // COAP_SERVER_HPP_ |