Adds a minimalistic API for managing the subscription object. The subscribe functionality will be brought in once we re-organize a bit weston-debug-stream and split it properly. It extends the logging context with a linked list of potential subscription and adds a linked list of subscriptions in the log scope. This patch represents the start of a logging framework for weston. It's being built around weston-debug, with the intent to superseded it, and make weston-debug a client of the framework. Further more the logging framework should replace current logging handler and allow other types of streams to be used. Currently present in libweston under weston-debug we have log scopes, debug streams and a logging context. With this patch, two (internal) objects are being added: the concept of a subscriber and the concept of subscription. The subscription object is a ephemeral object, implicitly managed which is created each time one would want to a subscribe to a scope. The scope will maintain a list of subscriptions and will continue to be explicitly managed. The streams will use the subscriber object as a base class to extend upon. By doing so it allows to customize the stream with specific functions that manipulate the underlaying storage. The subscriber object will require a subscribe function and specific stream functions and like the scope, will be explicitly managed. Signed-off-by: Marius Vlad <marius.vlad@collabora.com> Suggested-by: Pekka Paalanen <pekka.paalanen@collabora.com>dev
parent
e48bfc7c0c
commit
e0a858a5f2
@ -0,0 +1,80 @@ |
||||
/*
|
||||
* Copyright © 2019 Collabora Ltd |
||||
* |
||||
* Permission is hereby granted, free of charge, to any person obtaining |
||||
* a copy of this software and associated documentation files (the |
||||
* "Software"), to deal in the Software without restriction, including |
||||
* without limitation the rights to use, copy, modify, merge, publish, |
||||
* distribute, sublicense, and/or sell copies of the Software, and to |
||||
* permit persons to whom the Software is furnished to do so, subject to |
||||
* the following conditions: |
||||
* |
||||
* The above copyright notice and this permission notice (including the |
||||
* next paragraph) shall be included in all copies or substantial |
||||
* portions of the Software. |
||||
* |
||||
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, |
||||
* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF |
||||
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND |
||||
* NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS |
||||
* BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN |
||||
* ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN |
||||
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE |
||||
* SOFTWARE. |
||||
*/ |
||||
#ifndef WESTON_LOG_INTERNAL_H |
||||
#define WESTON_LOG_INTERNAL_H |
||||
|
||||
#include "wayland-util.h" |
||||
|
||||
/** Subscriber allows each type of stream to customize or to provide its own
|
||||
* methods to manipulate the underlying storage. It follows also an |
||||
* object-oriented approach, contains the ops callbacks and a list of |
||||
* subcriptions of type weston_log_subscription. Each subscription created will |
||||
* be both added to this subscription list and that of the weston_log_scope. |
||||
* |
||||
* A kind of stream can inherit the subscriber class and provide its own callbacks: |
||||
* @code |
||||
* struct weston_log_data_stream { |
||||
* struct weston_log_subscriber base; |
||||
* struct weston_data_stream opaque; |
||||
* }; |
||||
* @endcode |
||||
* |
||||
* Passing the base class will require container retrieval type of methods |
||||
* to be allowed to reach the opaque type (i.e., container_of()). |
||||
* |
||||
* @internal |
||||
* |
||||
*/ |
||||
struct weston_log_subscriber { |
||||
/** write the data pointed by @param data */ |
||||
void (*write)(struct weston_log_subscriber *sub, const char *data, size_t len); |
||||
/** For the type of streams that required additional destroy operation
|
||||
* for destroying the stream */ |
||||
void (*destroy)(struct weston_log_subscriber *sub); |
||||
/** For the type of streams that can inform the 'consumer' part that
|
||||
* write operation has been terminated/finished and should close the |
||||
* stream. |
||||
*/ |
||||
void (*complete)(struct weston_log_subscriber *sub); |
||||
struct wl_list subscription_list; /**< weston_log_subscription::owner_link */ |
||||
}; |
||||
|
||||
struct weston_log_subscription * |
||||
weston_log_subscription_create(struct weston_log_subscriber *owner, |
||||
const char *scope_name); |
||||
|
||||
void |
||||
weston_log_subscription_destroy(struct weston_log_subscription *sub); |
||||
|
||||
struct weston_log_subscription * |
||||
weston_log_subscriber_get_only_subscription(struct weston_log_subscriber *subscriber); |
||||
|
||||
void |
||||
weston_log_subscription_add(struct weston_log_scope *scope, |
||||
struct weston_log_subscription *sub); |
||||
void |
||||
weston_log_subscription_remove(struct weston_log_subscription *sub); |
||||
|
||||
#endif /* WESTON_LOG_INTERNAL_H */ |
Loading…
Reference in new issue