Detailed Description

Resource that echos back any incoming payload.

Definition at line 113 of file coap_resource.h.

#include <coap_resource.h>

Inheritance diagram for satcat5::coap::ResourceEcho:

Collaboration diagram for satcat5::coap::ResourceEcho:

Public Member Functions
constexpr	ResourceEcho (const char *uri_path)
	Constructor (user calls add_resource).

	ResourceEcho (ResourceServer server, const char uri_path)
	Constructor (parent class calls add_resource).

bool	request_get (Connection obj, Reader msg) override
	GET requests respond with the payload from the request.


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_post (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
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_post()

virtual bool satcat5::coap::Resource::request_post	(	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::ResourceLog, satcat5::coap::ResourceError, and satcat5::coap::ProxyResource.

Definition at line 91 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:

Detailed Description

Public Member Functions

Static Protected Member Functions

Protected Attributes

Private Attributes

Member Function Documentation

◆ request_delete()

◆ request_post()

◆ request_put()