Main Page | Modules | Namespace List | Class Hierarchy | Class List | File List | Class Members | File Members

SBlogInterface Struct Reference
[VXIlogInterface Implementation]

#include <SBlog.h>

List of all members.


Detailed Description

SBlog extension interface to the VXIlog interface.

SBlog defines extensions to the VXIlog interface that support the tag mechanism and the listener registration


Public Attributes

VXIlogInterface vxilog
 Base interface, must appear first.
VXIlogResult(* RegisterErrorListener )(struct SBlogInterface *pThis, SBlogErrorListener *alistener, void *userdata)
 Subscribe the given listener for errors.
VXIlogResult(* UnregisterErrorListener )(struct SBlogInterface *pThis, SBlogErrorListener *alistener, void *userdata)
 Unsubscribes the given listener.
VXIlogResult(* RegisterDiagnosticListener )(struct SBlogInterface *pThis, SBlogDiagnosticListener *alistener, void *userdata)
 Subscribe the given listener for a diagnostic message.
VXIlogResult(* UnregisterDiagnosticListener )(struct SBlogInterface *pThis, SBlogDiagnosticListener *alistener, void *userdata)
 Unsubscribes the given listener.
VXIlogResult(* ControlDiagnosticTag )(struct SBlogInterface *pThis, VXIunsigned tagID, VXIbool state)
 Turn the diagnostic tag on (true) or off (false).
VXIlogResult(* RegisterEventListener )(struct SBlogInterface *pThis, SBlogEventListener *alistener, void *userdata)
 Subscribe the given listener for events.
VXIlogResult(* UnregisterEventListener )(struct SBlogInterface *pThis, SBlogEventListener *alistener, void *userdata)
 Unsubscribes the given listener.
VXIlogResult(* RegisterContentListener )(struct SBlogInterface *pThis, SBlogContentListener *alistener, void *userdata)
 Subscribe the given listener for content write requests.
VXIlogResult(* UnregisterContentListener )(struct SBlogInterface *pThis, SBlogContentListener *alistener, void *userdata)
 Unsubscribes the given listener.


Member Data Documentation

VXIlogResult(* SBlogInterface::ControlDiagnosticTag)(struct SBlogInterface *pThis, VXIunsigned tagID, VXIbool state)
 

Turn the diagnostic tag on (true) or off (false).

All diagnostic log tags are assumed to be off unless specifically enabled. This must be done by calling this function and setting the given tag to true.

Parameters:
tagID [IN] Identifier that classifies a group of logically associated diagnostic messages (usually from a single software module) that are desirable to enable or disable as a single unit. See the top of this file for tagID allocation rules.
state [IN] Boolean flag to turn the tag on (TRUE) or off (FALSE).
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::RegisterContentListener)(struct SBlogInterface *pThis, SBlogContentListener *alistener, void *userdata)
 

Subscribe the given listener for content write requests.

The given listener will be notified for all content write requests (via VXIlog::ContentOpen( ) calls) as each request is processed by SBlog. The call cannot be disabled.

Parameters:
alistener [IN] Subscribing listener
userdata [IN] User data that will be returned to the listener when notification occurs. Note: the same listener may be registered multiple times, as long as unique userdata is passed. In this case, the listener will be called once for each unique userdata.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::RegisterDiagnosticListener)(struct SBlogInterface *pThis, SBlogDiagnosticListener *alistener, void *userdata)
 

Subscribe the given listener for a diagnostic message.

The given listener will be notified for all diagnostic messages (via VXIlog::Diagnostic or VDiagnostic calls) as each calls is processed by SBlog. The set of Diagnostics that are returned is controlled by ControlDiagnosticTag to either true or false. By default all tags are assumed to be false when the listener is registered, and therefore off. A tag must be specifically turned to true (enabled) before any callbacks will be generated. If a tag is enabled, all callbacks that registered on a given SBlog interface will be invoked. Generally, only one callback will be registered on each interface.

Parameters:
alistener [IN] Subscribing listener
userdata [IN] User data that will be returned to the listener when notification occurs. Note: the same listener may be registered multiple times, as long as unique userdata is passed. In this case, the listener will be called once for each unique userdata.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::RegisterErrorListener)(struct SBlogInterface *pThis, SBlogErrorListener *alistener, void *userdata)
 

Subscribe the given listener for errors.

The given listener will be notified for all errors (via VXIlog::Error or VError calls) as each calls is processed by SBlog. The call cannot be disabled.

Parameters:
alistener [IN] Subscribing listener
userdata [IN] User data that will be returned to the listener when notification occurs. Note: the same listener may be registered multiple times, as long as unique userdata is passed. In this case, the listener will be called once for each unique userdata.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::RegisterEventListener)(struct SBlogInterface *pThis, SBlogEventListener *alistener, void *userdata)
 

Subscribe the given listener for events.

The given listener will be notified for all events (via VXIlog::Event or VEvent calls) as each calls is processed by SBlog. The call cannot be disabled.

Parameters:
alistener [IN] Subscribing listener
userdata [IN] User data that will be returned to the listener when notification occurs. Note: the same listener may be registered multiple times, as long as unique userdata is passed. In this case, the listener will be called once for each unique userdata.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::UnregisterContentListener)(struct SBlogInterface *pThis, SBlogContentListener *alistener, void *userdata)
 

Unsubscribes the given listener.

Unsubscribes the given listener/userdata combination.

Parameters:
alistener [IN] The subscribing listener
userdata [IN] User data that was passed in during registration.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::UnregisterDiagnosticListener)(struct SBlogInterface *pThis, SBlogDiagnosticListener *alistener, void *userdata)
 

Unsubscribes the given listener.

Unsubscribes the given listener/userdata combination.

Parameters:
alistener [IN] The subscribing listener
userdata [IN] User data that was passed in during registration.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::UnregisterErrorListener)(struct SBlogInterface *pThis, SBlogErrorListener *alistener, void *userdata)
 

Unsubscribes the given listener.

Unsubscribes the given listener/userdata combination.

Parameters:
alistener [IN] The subscribing listener
userdata [IN] User data that was passed in during registration.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogResult(* SBlogInterface::UnregisterEventListener)(struct SBlogInterface *pThis, SBlogEventListener *alistener, void *userdata)
 

Unsubscribes the given listener.

Unsubscribes the given listener/userdata combination.

Parameters:
alistener [IN] The subscribing listener
userdata [IN] User data that was passed in during registration.
Returns:
VXIlog_RESULT_SUCCESS: success

VXIlog_RESULT_SYSTEM_ERROR: internal error

VXIlogInterface SBlogInterface::vxilog
 

Base interface, must appear first.


The documentation for this struct was generated from the following file:
Generated on Wed Jun 1 12:50:19 2005 for OpenVXI by  doxygen 1.4.2