omni::log::WildcardLogChannelFilter

Defined in omni/log/WildcardLogChannelFilter.h

Inheritance Relationships

Base Type

class omni::log::WildcardLogChannelFilter : public omni::core::Implements<ILogChannelFilter>

ILogChannelFilter implementation that supports pattern matching via wildcards (e.g. * and ?).

Public Functions

inline void setEnabled(bool enabled, SettingBehavior behavior) noexcept

Tells the filter to set the enabled settings when a channel matches.

If this method is not called, the filter will not set any enabled settings.

This method is not thread safe and should only be called before the filter is added to a ILogChannelFilterList.

inline void setLevel(Level level, SettingBehavior behavior) noexcept

Tells the filter to set the level settings when a channel matches.

If this method is not called, the filter will not set any level settings.

This method is not thread safe and should only be called before the filter is added to a ILogChannelFilterList.

inline void acquire() noexcept

See omni::core::IObject::acquire.

inline void release() noexcept

See omni::core::IObject::release.

inline void *cast(omni::core::TypeId id) noexcept

See omni::core::IObject::cast.

Public Static Functions

static inline omni::core::ObjectPtr<WildcardLogChannelFilter> create(const char *wildcard)

Creates a filter with the given pattern.

Parameters

wildcard – [in] The wildcard pattern that this object will represent. This may not be nullptr.

Returns

The newly constructed object containing the given wildcard pattern.

Protected Functions

inline const char *getFilter_abi() noexcept override

Returns the channels pattern. The returned memory is valid for the lifetime of this object.

This method is thread safe.

inline virtual void getEnabled_abi(bool *enabled, SettingBehavior *behavior, bool *isUsed) noexcept override

Returns the desired enabled state for this filter.

All parameters must not be nullptr.

If *isUsed is false after calling this method, *isEnabled and *behavior should not be used.

This method is thread safe.

inline virtual void getLevel_abi(Level *level, SettingBehavior *behavior, bool *isUsed) noexcept override

Returns the desired level for this filter.

All parameters must not be nullptr.

If *isUsed is false after calling this method, *level and *behavior should not be used.

This method is thread safe.

inline virtual bool isMatch_abi(const char *channel) noexcept override

Given a channel name, returns if the channel name matches the filter’s pattern.

The matching algorithm used is implementation specific (e.g. regex, glob, etc).

This method is thread safe.

inline virtual void acquire_abi() noexcept override

Increments the object’s reference count.

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

inline virtual void release_abi() noexcept override

Decrements the objects reference count.

Most implementations will destroy the object if the reference count reaches 0 (though this is not a requirement).

Objects may have multiple reference counts (e.g. one per interface implemented). As such, it is important that you call omni::core::IObject::release() on the same pointer from which you called omni::core::IObject::acquire().

Do not directly use this method, rather use omni::core::ObjectPtr, which will manage calling omni::core::IObject::acquire() and omni::core::IObject::release() for you.

Thread Safety

This method is thread safe.

inline virtual void *cast_abi(TypeId id) noexcept override

Returns a pointer to the interface defined by the given type id if this object implements the type id’s interface.

Objects can support multiple interfaces, even interfaces that are in different inheritance chains.

The returned object will have omni::core::IObject::acquire() called on it before it is returned, meaning it is up to the caller to call omni::core::IObject::release() on the returned pointer.

The returned pointer can be safely reinterpret_cast<> to the type id’s C++ class. For example, “omni.windowing.IWindow” can be cast to omni::windowing::IWindow.

Do not directly use this method, rather use a wrapper function like omni::core::cast() or omni::core::ObjectPtr::as().

Thread Safety

This method is thread safe.

Protected Attributes

std::atomic<uint32_t> m_refCount

Reference count.