svcadm(8)을 검색하려면 섹션에서 8 을 선택하고, 맨 페이지 이름에 svcadm을 입력하고 검색을 누른다.
HBA_RegisterForAdapterEvents(3hbaapi)
HB...s(3HBAAPCIo)mmon Fibre Channel HBA Information Library FunctioHnBs...s(3HBAAPI)
NAME
HBA_RegisterForAdapterEvents, HBA_RegisterForAdapterAddEvents, HBA_Reg‐
isterForAdapterPortEvents, HBA_RegisterForAdapterPortStatEvents,
HBA_RegisterForTargetEvents, HBA_RegisterForLinkEvents, HBA_RemoveCall‐
back - SNIA event handling functions
SYNOPSIS
cc [ flag... ] file... -lHBAAPI [ library... ]
#include <hbaapi.h>
HBA_STATUS HBA_RegisterForAdapterEvents(void (*pCallback)
(void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType),
void *pUserData, HBA_HANDLE handle,
HBA_CALLBACKHANDLE *pCallbackHandle);
HBA_STATUS HBA_RegisterForAdapterAddEvents(void (*pCallback)
(void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType),
void *pUserData, HBA_CALLBACKHANDLE *pCallbackHandle);
HBA_STATUS HBA_RegisterForAdapterPortEvents(void (*pCallback)
(void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType,
HBA_UINT32 fabricPortID), void *pUserData, HBA_HANDLE handle,
HBA_WWN PortWWN, HBA_CALLBACKHANDLE *pCallbackHandle);
HBA_STATUS HBA_RegisterForAdapterPortStatEvents(void (*pCallback)
(void *pData, HBA_WWN PortWWN, HBA_UINT32 eventType),
void *pUserData, HBA_HANDLE handle, HBA_WWN PortWWN,
HBA_PortStatistics stats, HBA_UINT32 statType,
HBA_CALLBACKHANDLE *pCallbackHandle);
HBA_STATUS HBA_RegisterForTargetEvents(void (*pCallback)
(void *pData, HBA_WWN hbaPortWWN, HBA_WWN discoveredPortWWN,
HBA_UINT32 eventType), void * pUserData, HBA_HANDLE handle,
HBA_WWN hbaPortWWN, HBA_WWN discoveredPortWWN,
HBA_CALLBACKHANDLE *pCallbackHandle, HBA_UINT32 allTargets);
HBA_STATUS HBA_RegisterForLinkEvents(void (*pCallback)
(void *pData, HBA_WWN adapterWWN, HBA_UINT32 eventType,
void * pRLIRBuffer, HBA_UINT32 RLIRBufferSize),
void *pUserData, void *PLIRBuffer, HBA_UINT32 RLIRBufferSize,
HBA_HANDLE handle, HBA_CALLBACKHANDLE *pCallbackHandle);
HBA_STATUS HBA_RemoveCallback(HBA_CALLBACKHANDLE *pCallbackHandle);
PARAMETERS
pCallback
A pointer to the entry of the callback routine.
pData
the pUserData that is passed in from registration. This parame‐
ter can be used to correlate the event with the source of its
event registration.
PortWWN
The Port WWN of the HBA for which the event is being reported.
hbaPortWWN
The Port WWN of the HBA for which the target event is being re‐
ported.
discoveredPortWWN
The Port WWN of the target for which the target event is being
reported.
adapterWWN
The Port WWN of the of the HBA for which the link event is be‐
ing reported.
eventType
a value indicating the type of event that has occurred.
HBA_RegisterForAdapterEvents()
Possible values are HBA_EVENT_ADAPTER_REMOVE and
HBA_EVENT_ADAPTER_CHANGE.
HBA_RegisterForAdaterAddEvents()
The only possible value is HBA_EVENT_ADAPTER_ADD.
HBA_RegisterForAdaterPortEvents()
Possible values are HBA_EVENT_PORT_OFFLINE,
HBA_EVENT_PORT_ONLINE, HBA_EVENT_PORT_NEW_TARGETS,
HBA_EVENT_PORT_FABRIC, and HBA_EVENT_PORT_UNKNOWN.
HBA_RegisterForAdapterPortStatEvents()
Possible values are HBA_EVENT_PORT_STAT_THRESHOLD and
HBA_EVENT_PORT_STAT_GROWTH.
HBA_RegisterForTargetEvents()
If the value is HBA_EVENT_LINK_INCIDENT, RLIR has occurred
and information is in the RLIRBuffer. If the value is
HBA_EVENT_LINK_UNKNOWN, a fabric link or topology change
has occurred and was not detected by RLIR. The RLIRBuffer
is ignored
HBA_RegisterForLinkEvents()
Possible values are HBA_EVENT_TARGET_OFFLINE,
HBA_EVENT_TARGET_ONLINE, HBA_EVENT_TARGET_REMOVED, and
HBA_EVENT_TARGET_UNKNOWN.
fabricPortID
If the event is of type HBA_EVENT_PORT_FABRIC, this parameter
will be the RSCN-affected Port ID page as defined in FC-FS. It
is ignored for all other event types.
pRLIRBuffer
A pointer to a buffer where RLIR data may be passed to the
callback function. The buffer will be overwritten for each fab‐
ric link callback function, but will not be overwritten within
a single call to the callback function.
RLIRBufferSize
Size in bytes of the RLIRBuffer.
pUserData
a pointer passed with each event to the callback routine that can
be used to correlate the event with the source of its event regis‐
tration
pRLIRBuffer
A pointer to a buffer where RLIR data may be passed to the callback
function. The buffer will be overwritten for each fabric link call‐
back function, but will not be overwritten within a single call to
the callback function.
RLIRBufferSize
Size in bytes of the RLIRBuffer.
handle
a handle to the HBA that event callbacks are being requested
PortWWN
The Port WWN of the HBA for which the event is being reported.
hbaPortWWN
The Port WWN of the HBA of which the event callbacks are being re‐
quested.
stats
an HBA_PortStatistics structure which indicates the counters to be
monitored. If statType is HBA_EVENT_PORT_STAT_THRESHOLD, any non-
null values are thresholds for which to watch. If statType is
HBA_EVET_PORT_STAT_GROWTH, any non-null values are growth rate num‐
bers over 1 minute.
statType
A value either HBA_EVENT_PORT_STAT_THRESHOLD or
HBA_EVENT_PORT_STAT_GROWTH used to determine whether counters reg‐
istered are for threshold crossing or growth rate.
discoveredPortWWN
The Port WWN of the target that the event callbacks are being re‐
quested of.
pCallbackHandle
A pointer to structure in which an opaque identifier is returned
that is used to deregister the callback. To deregister this event,
call HBA_RemoveCallback() with this pCallbackHandle as an argument.
allTargets
If value is non-zero, discoveredPortWWN is ignored. Events for all
discovered targets will be registered by this call. If value is
zero, only events for discoveredPortWWN will be registered.
pcallbackHandle
A handle returned by the event registration function of the routine
that is to be removed.
DESCRIPTION
The HBA_RegisterForAdapterEvents() function registers an application-
defined function that is called when an HBA category asynchronous event
occurs. An HBA category event can have one of the following event
types: HBA_EVENT_ADAPTER_REMOVE or HBA_EVENT_ADAPTER_CHANGE. If either
of these events occur, the callback function is called, regardless of
whether the HBA handle specified at registration is open. The HBA_Re‐
moveCallback() function must be called to end event delivery.
The HBA_RegisterForAdapterAddEvents() function registers an applica‐
tion-defined function that is called whenever an HBA add category asyn‐
chronous event occurs. The callback function is called when a new HBA
is added to the local system. The HBA_RemoveCallback() function must be
called to end event delivery.
The HBA_RegisterForAdapterPortEvents() function registers an applica‐
tion-defined function that is called on the specified HBA whenever a
port category asynchronous event occurs. A port category event can be
one of the following event types: HBA_EVENT_PORT_OFFLINE,
HBA_EVENT_PORT_ONLINE, HBA_EVENT_PORT_NEW_TARGETS, HBA_EVENT_PORT_FAB‐
RIC, or HBA_EVENT_PORT_UNKNOWN. The handle need not be open for call‐
backs to occur. The HBA_RemoveCallback() function must be called to end
event delivery.
The HBA_RegisterForAdapterPortStatEvents() function defines conditions
that would cause an HBA port statistics asynchronous event and regis‐
ters an application-defined function that is called whenever one of
these events occur. An HBA port statistics asynchronous event can be
one of the following event types: HBA_EVENT_PORT_STAT_THRESHOLD or
HBA_EVENT_PORT_STAT_GROWTH. More than one statistic can be registered
with one call by setting multiple statistics in the stats argument. For
threshold events, once a specific threshold has been crossed, the call‐
back is automatically deregistered for that statistic. The handle need
not be open for callbacks to occur. The HBA_RemoveCallback() function
must be called to end event delivery.
The HBA_RegisterForTargetEvents() function registers an application-de‐
fined function that is called on the specified HBA whenever a target
category asynchronous event occurs. A Target category event can be one
of the following event types: HBA_EVENT_TARGET_OFFLINE, HBA_EVENT_TAR‐
GET_ONLINE, HBA_EVENT_TARGET_REMOVED, HBA_EVENT_TARGET_UNKNOWN. The
handle need not be open for callbacks to occur. The HBA_RemoveCall‐
back() function must be called to end event delivery.
The HBA_RegisterForLinkEvents() function registers an application de‐
fined function that is called on the specified HBA whenever a link cat‐
egory asynchronous event occurs. A link category event can be one of
the following event types: HBA_EVENT_LINK_INCIDENT or
HBA_EVENT_LINK_UNKNOWN. RLIR ELS is the only fabric link event type and
the callback function is called whenever is it detected by the HBA. The
handle need not be open for callbacks to occur. The HBA_RemoveCall‐
back() function must be called to end event delivery.
The HBA_RemoveCallback() function removes the HBA_CALLBACKHANDLE in‐
stance of the callback routine.
RETURN VALUES
Upon successful completion, HBA_RegisterForAdapterEvents(), HBA_Regis‐
terForAdapterAddEvents(), HBA_RegisterForAdapterPortEvents(), HBA_Reg‐
isterForAdapterPortStatEvents(), HBA_RegisterForTargetEvents(), and
HBA_RegisterForLinkEvents() return HBA_STATUS_OK and pCallbackHandle
may be used to deregister the callback. Otherwise, an error value is
returned and pCallbackHandle is not valid.
Upon successful completion, HBA_RemoveCallback() returns HBA_STATUS_OK.
Otherwise, an error value is returned.
ERRORS
See libhbaapi(3LIB) for general error status values.
ATTRIBUTES
See attributes(7) for descriptions of the following attributes:
tab() box; cw(2.75i) |cw(2.75i) lw(2.75i) |lw(2.75i) ATTRIBUTE TYPEAT‐
TRIBUTE VALUE _ Interface StabilityCommitted _ T{ Standard: FC-HBA Ver‐
sion 4 (API version 2) T} _ MT-LevelSafe _ StandardFC-MI 1.92 (API ver‐
sion 1)
SEE ALSO
libhbaapi(3LIB), attributes(7)
T11 FC-MI Specification
Oracle Solaris 11.4 27 Nov 2017 HB...s(3HBAAPI)