Coap::ObserverRegistry< N > Class Template Reference

A resource observer registry. More...

#include <Observers.h>

Public Member Functions
Observer &	operator[] (size_t index)
	Get the observer at the given index.
const Observer &	operator[] (size_t index) const
	Get the observer at the given index.
size_t	length () const
	Get the maximum number of observers that can be stored in the registry.
size_t	countActive () const
	Get the number of active observers currently stored in the registry.
ErrorCode	add (IPAddress ip, uint16_t port, const uint8_t *token, uint8_t tokenLength)
	Add a new active observer to the registry.
ErrorCode	add (Observer observer)
	Add a new observer to the registry.
ErrorCode	remove (IPAddress ip, uint16_t port, const uint8_t *token, uint8_t tokenLength)
	Remove an observer from the registry.
ErrorCode	remove (IPAddress ip, uint16_t port)
	Remove any observers with the given combination of IP and port.
ErrorCode	remove (IPAddress ip)
	Remove any observers with the given IP.
ErrorCode	remove (const Observer &observer)
	Remove an observer from the registry.
ErrorCode	removeStale ()
	Removes all stale observers from the registry.

Detailed Description

template<size_t N>
class Coap::ObserverRegistry< N >

A resource observer registry.

It tracks the observers registered to a specific resource.

Example:

Coap::ObserverRegistry<5> myRegistry; // Create a registry with a maximum of 5 observers.
myRegistry.add(ip1, port1, token1, tokenLength1); // Add an observer to the registry.
Observer &observer = myRegistry[0]; // Get the first observer in the registry.

Member Function Documentation

add() [1/2]

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::add ( IPAddress ip, uint16_t port, const uint8_t * token, uint8_t tokenLength )

inline

Add a new active observer to the registry.

If an active observer with same data already exists, it will not be added again.

Parameters

ip	The IP address of the observer.
port	The port of the observer.
token	The token used by the observer.
tokenLength	The length of the token in bytes.

See also

add(Observer observer) for the version that accepts an Observer object.

Note

RFC-7641 section 4.1 specifies that the list of observers is keyed by endpoint and token. Each ObserverRegistry instance will be associated to a specific resource/endpoint, so that there is no need to record the endpoint within the registry. Observers are also keyed by IP address and port to differenciate among multiple clients using the same token. Therefore the combination of IP, port and token fully identifies the observer.

add() [2/2]

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::add ( Observer observer )

inline

Add a new observer to the registry.

If the observer already exists and is active, it will not be added again.

Parameters

observer

The observer to be added. The observer must be active to be added to the registry.

Returns

An error code indicating success or failure. It will return ErrorCode::OK if the observer is successfully added (or was already present). It will return ErrorCode::NOT_SUPPORTED if the registry is full and the observer cannot be added.

countActive()

template<size_t N>

size_t Coap::ObserverRegistry< N >::countActive ( ) const

inline

Get the number of active observers currently stored in the registry.

Returns

The number of active observers.

length()

template<size_t N>

size_t Coap::ObserverRegistry< N >::length ( ) const

inline

Get the maximum number of observers that can be stored in the registry.

Returns

The maximum number of entries.

operator[]() [1/2]

template<size_t N>

Observer & Coap::ObserverRegistry< N >::operator[] ( size_t index )

inline

Get the observer at the given index.

Parameters

index

Returns

Reference to the observer.

operator[]() [2/2]

template<size_t N>

const Observer & Coap::ObserverRegistry< N >::operator[] ( size_t index ) const

inline

Get the observer at the given index.

Parameters

index

Returns

Const reference to the observer.

remove() [1/4]

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::remove ( const Observer & observer )

inline

Remove an observer from the registry.

Parameters

observer

The observer to be removed.

Returns

An error code indicating success or failure.

See also

remove(IPAddress ip, uint16_t port, const uint8_t *token, uint8_t tokenLength) for more details.

remove() [2/4]

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::remove ( IPAddress ip )

inline

Remove any observers with the given IP.

Parameters

ip	The IP address of the observer(s) to remove.

Returns

An error code indicating success or failure. It will return ErrorCode::OK if one or more observers have been removed. It will return ErrorCode::NOT_FOUND if no matching observer is found

See also

remove(IPAddress ip, uint16_t port, const uint8_t *token, uint8_t tokenLength) for the token-specific version.

remove() [3/4]

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::remove ( IPAddress ip, uint16_t port )

inline

Remove any observers with the given combination of IP and port.

Parameters

ip	The IP address of the observer(s) to remove.
port	The port of the observer(s).

Returns

An error code indicating success or failure. It will return ErrorCode::OK if one or more observers have been removed. It will return ErrorCode::NOT_FOUND if no matching observer is found

See also

remove(IPAddress ip, uint16_t port, const uint8_t *token, uint8_t tokenLength) for the token-specific version.

remove() [4/4]

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::remove ( IPAddress ip, uint16_t port, const uint8_t * token, uint8_t tokenLength )

inline

Remove an observer from the registry.

The observer must match the provided combination of IP address, port, token and token length.

Parameters

ip	The IP address of the observer that needs to be removed.
port	The port of the observer.
token	The token used by the observer.
tokenLength	The length of the token in bytes.

Returns

An error code indicating success or failure. It will return ErrorCode::OK if the observer is successfully removed. It will return ErrorCode::NOT_FOUND if no matching observer is found

removeStale()

template<size_t N>

ErrorCode Coap::ObserverRegistry< N >::removeStale ( )

inline

Removes all stale observers from the registry.

Returns

ErrorCode::OK.

See also

Observer::isStale().

---

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

• src/Observers.h