SatCat5
Public Member Functions | Static Protected Member Functions | Protected Attributes | Private Attributes | List of all members
satcat5::coap::ResourceLog Class Reference

Detailed Description

Resource that creates a log::Log entry.

Definition at line 154 of file coap_resource.h.

#include <coap_resource.h>

Inheritance diagram for satcat5::coap::ResourceLog:
[legend]
Collaboration diagram for satcat5::coap::ResourceLog:
[legend]

Public Member Functions

constexpr ResourceLog (const char *uri_path, s8 priority)
 Constructor (user calls add_resource).
 
 ResourceLog (ResourceServer *server, const char *uri_path, s8 priority)
 Constructor (parent class calls add_resource).
 
bool request_post (Connection *obj, Reader *msg) override
 POST requests create a log::Log entry.
 
bool operator== (const Resource &other) const
 Comparison operators for comparing two URI-paths.
 
bool operator!= (const Resource &other) const
 Comparison operators for comparing two URI-paths.
 
satcat5::ip::Dispatch * ip () const
 Pointer to the parent's network interface.
 
satcat5::udp::Dispatch * udp () const
 Pointer to the parent's network interface.
 
virtual bool request_get (Connection *obj, Reader *msg)
 Event handlers for GET, POST, PUT, and DELETE queries. More...
 
virtual bool request_put (Connection *obj, Reader *msg)
 Event handlers for GET, POST, PUT, and DELETE queries. More...
 
virtual bool request_delete (Connection *obj, Reader *msg)
 Event handlers for GET, POST, PUT, and DELETE queries. More...
 

Static Protected Member Functions

static constexpr const char * normalize_uri (const char *uri)
 Remove leading slash from a user-provided path.
 

Protected Attributes

s8 m_priority
 Priority for created log messages.
 
const char *const m_uri_path
 URI-Path for this resource.
 
ResourceServer *const m_server
 Optional pointer to the server object.
 

Private Attributes

Resource * m_next
 

Member Function Documentation

◆ request_delete()

virtual bool satcat5::coap::Resource::request_delete ( Connection *  obj,
Reader *  msg 
)
inlinevirtualinherited

Event handlers for GET, POST, PUT, and DELETE queries.

The Child class SHOULD override at least one of the following event handlers corresponding to GET, POST, PUT, and DELETE requests, respectively. Default behavior is to respond with the 4.05 Method Not Allowed error code.

Reimplemented in satcat5::coap::ResourceError, and satcat5::coap::ProxyResource.

Definition at line 95 of file coap_resource.h.

◆ request_get()

virtual bool satcat5::coap::Resource::request_get ( Connection *  obj,
Reader *  msg 
)
inlinevirtualinherited

Event handlers for GET, POST, PUT, and DELETE queries.

The Child class SHOULD override at least one of the following event handlers corresponding to GET, POST, PUT, and DELETE requests, respectively. Default behavior is to respond with the 4.05 Method Not Allowed error code.

Reimplemented in satcat5::coap::ResourceError, satcat5::coap::ResourceEcho, and satcat5::coap::ProxyResource.

Definition at line 89 of file coap_resource.h.

◆ request_put()

virtual bool satcat5::coap::Resource::request_put ( Connection *  obj,
Reader *  msg 
)
inlinevirtualinherited

Event handlers for GET, POST, PUT, and DELETE queries.

The Child class SHOULD override at least one of the following event handlers corresponding to GET, POST, PUT, and DELETE requests, respectively. Default behavior is to respond with the 4.05 Method Not Allowed error code.

Reimplemented in satcat5::coap::ResourceError, and satcat5::coap::ProxyResource.

Definition at line 93 of file coap_resource.h.

The documentation for this class was generated from the following files: