etraceprovider-1 - Private API used by ETrace server
#include <rad/client/1/etraceprovider.h>
cc [ flag... ] file... -letraceprovider1_client [ library... ]
interface ETraceProvider
rc_err_t etraceprovider_ETraceProvider_providerClientInfo(rc_instance_t *inst,
etraceprovider_ETraceProviderInfo_t ***result,
int *result_cnt,
etraceprovider_ETraceProviderError_t **error);
rc_err_t etraceprovider_ETraceProvider_providerServerInfo(rc_instance_t *inst,
const char *provider_name,
etraceprovider_ETraceProviderInfo_t ***result,
int *result_cnt,
etraceprovider_ETraceProviderError_t **error);
rc_err_t etraceprovider_ETraceProvider_providerClientEnable(rc_instance_t *inst,
const rc_opaque_t *data,
etraceprovider_ETraceProviderError_t **error);
rc_err_t etraceprovider_ETraceProvider_providerClientDisable(rc_instance_t *inst,
const rc_opaque_t *data,
etraceprovider_ETraceProviderError_t **error);
Structured Types
struct ETraceProviderError
typedef struct etraceprovider_ETraceProviderError
etraceprovider_ETraceProviderError_t;
struct etraceprovider_ETraceProviderError {
int eetpe_err;
char *eetpe_errmsg;
};
void etraceprovider_ETraceProviderError_free(etraceprovider_ETraceProviderError_t *in);
struct ETraceProviderInfo
typedef struct etraceprovider_ETraceProviderInfo
etraceprovider_ETraceProviderInfo_t;
struct etraceprovider_ETraceProviderInfo {
char *eetpi_provider;
char *eetpi_metadata;
char **eetpi_clients;
int eetpi_clients_count;
};
void etraceprovider_ETraceProviderInfo_free(etraceprovider_ETraceProviderInfo_t *in);
ETRACEPROVIDER-1(3rad) RAD Module Definitions ETRACEPROVIDER-1(3rad)
NAME
etraceprovider - Private API used by ETrace server
SYNOPSIS
#include <rad/client/1/etraceprovider.h>
cc [ flag... ] file... -letraceprovider1_client [ library... ]
interface ETraceProvider
rc_err_t etraceprovider_ETraceProvider_providerClientInfo(rc_instance_t *inst,
etraceprovider_ETraceProviderInfo_t ***result,
int *result_cnt,
etraceprovider_ETraceProviderError_t **error);
rc_err_t etraceprovider_ETraceProvider_providerServerInfo(rc_instance_t *inst,
const char *provider_name,
etraceprovider_ETraceProviderInfo_t ***result,
int *result_cnt,
etraceprovider_ETraceProviderError_t **error);
rc_err_t etraceprovider_ETraceProvider_providerClientEnable(rc_instance_t *inst,
const rc_opaque_t *data,
etraceprovider_ETraceProviderError_t **error);
rc_err_t etraceprovider_ETraceProvider_providerClientDisable(rc_instance_t *inst,
const rc_opaque_t *data,
etraceprovider_ETraceProviderError_t **error);
Structured Types
struct ETraceProviderError
typedef struct etraceprovider_ETraceProviderError
etraceprovider_ETraceProviderError_t;
struct etraceprovider_ETraceProviderError {
int eetpe_err;
char *eetpe_errmsg;
};
void etraceprovider_ETraceProviderError_free(etraceprovider_ETraceProviderError_t *in);
struct ETraceProviderInfo
typedef struct etraceprovider_ETraceProviderInfo
etraceprovider_ETraceProviderInfo_t;
struct etraceprovider_ETraceProviderInfo {
char *eetpi_provider;
char *eetpi_metadata;
char **eetpi_clients;
int eetpi_clients_count;
};
void etraceprovider_ETraceProviderInfo_free(etraceprovider_ETraceProviderInfo_t *in);
DESCRIPTION
API com.oracle.solaris.rad.etraceprovider [1]
Private API used by the ETrace server to retrieve per-client provider
information and to enable/disable providers.
INTERFACES
interface ETraceProvider
Private end-to-end tracing client daemon interface.
Private implementation of end-to-end tracing client daemon interface.
ETraceProvider Methods
rc_err_t etraceprovider_ETraceProvider_providerClientInfo(rc_instance_t *inst,
etraceprovider_ETraceProviderInfo_t ***result,
int *result_cnt,
etraceprovider_ETraceProviderError_t **error);
Returns information about the specified provider, if a provider
is specified, or about all providers otherwise. This function
returns the info provider for the ETrace client.
Arguments:
inst -- RAD instance
result
result_cnt -- Number of items in result array
error
rc_err_t etraceprovider_ETraceProvider_providerServerInfo(rc_instance_t *inst,
const char *provider_name,
etraceprovider_ETraceProviderInfo_t ***result,
int *result_cnt,
etraceprovider_ETraceProviderError_t **error);
Returns information about the specified provider, if a provider
is specified, or about all providers otherwise. This function
returns the info provider for the ETrace server.
Arguments:
inst -- RAD instance
provider_name -- Specifies the name of the provider to be
returned. If an empty string, will return all providers.
result
result_cnt -- Number of items in result array
error
rc_err_t etraceprovider_ETraceProvider_providerClientEnable(rc_instance_t *inst,
const rc_opaque_t *data,
etraceprovider_ETraceProviderError_t **error);
Arguments:
inst -- RAD instance
data -- Packed nvlist containg name and arguments for the
provider. We use a packed nvlist which can be pre-packed and
shared across multiple client instances.
error
rc_err_t etraceprovider_ETraceProvider_providerClientDisable(rc_instance_t *inst,
const rc_opaque_t *data,
etraceprovider_ETraceProviderError_t **error);
Arguments:
inst -- RAD instance
data -- Packed nvlist containg name and arguments for the
provider.
error
ETraceProvider Retrieve
rc_err_t etraceprovider_ETraceProvider__rad_get_name(adr_name_t **result,
int n,
...);
Obtain RAD name of a ETraceProvider object.
Arguments:
result -- RAD name
n -- Number of key-value pairs provided as variadic arguments
... -- Optional key-value pairs that compose the primary key
rc_err_t etraceprovider_ETraceProvider__rad_lookup(rc_conn_t *c,
boolean_t strict,
rc_instance_t **result,
int n,
...);
Lookup a ETraceProvider instance.
Construct a RAD name for the interface based on the provided
key-value pairs and perform a lookup. If successful, instance
reference is returned in the result.
Arguments:
c -- RAD connection handle
strict -- Strict (B_TRUE) or relaxed (B_FALSE) versioning
result -- RAD instance
n -- Number of key-value pairs provided as variadic arguments
... -- Optional key-value pairs that compose the primary key
rc_err_t etraceprovider_ETraceProvider__rad_list(rc_conn_t *c,
boolean_t strict,
adr_pattern_scheme_t scheme,
adr_name_t ***result,
int *result_count,
int n,
...);
List RAD names of a available ETraceProvider instances.
Returns an array and array size of matching object names.
Arguments:
c -- RAD connection handle
strict -- Strict (B_TRUE) or relaxed (B_FALSE) versioning
scheme -- Apply glob (NS_GLOB) or regex (NS_REGEX) matching
result -- Array of RAD names
result_count -- Number of names in result array
n -- Number of key-value pairs provided as variadic arguments
... -- Optional key-value pairs that compose the primary key
STRUCTURED TYPES
struct ETraceProviderError
typedef struct etraceprovider_ETraceProviderError
etraceprovider_ETraceProviderError_t;
struct etraceprovider_ETraceProviderError {
int eetpe_err;
char *eetpe_errmsg;
};
void etraceprovider_ETraceProviderError_free(etraceprovider_ETraceProviderError_t *in);
Fields:
eetpe_err
eetpe_errmsg
struct ETraceProviderInfo -- Provider information.
typedef struct etraceprovider_ETraceProviderInfo
etraceprovider_ETraceProviderInfo_t;
struct etraceprovider_ETraceProviderInfo {
char *eetpi_provider;
char *eetpi_metadata;
char **eetpi_clients;
int eetpi_clients_count;
};
void etraceprovider_ETraceProviderInfo_free(etraceprovider_ETraceProviderInfo_t *in);
Fields:
eetpi_provider
eetpi_metadata
eetpi_clients
eetpi_clients_count
VERSION
1.0
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
+--------------------+-------------------------------------------------+
| ATTRIBUTE TYPE | ATTRIBUTE VALUE |
+--------------------+-------------------------------------------------+
|Availability | system/management/rad/module/rad-etraceprovider |
+--------------------+-------------------------------------------------+
|Interface Stability | Private |
+--------------------+-------------------------------------------------+
SEE ALSO
rad(8)
NOTES
1. Accessing Python documentation for this module:
$ pydoc rad.bindings.com.oracle.solaris.rad.etraceprovider_1
Solaris 11.4 2017-02-01 ETRACEPROVIDER-1(3rad)