HBA_RegisterForLinkEvents function (hbaapi.h)

Registers with a specified adapter for asynchronous fabric link-level events.

Syntax

HBA_STATUS HBA_API HBA_RegisterForLinkEvents(
  void(* )(void *data,HBA_WWN adapterWWN,HBA_UINT32 eventType, void *pRLIRBuffer,HBA_UINT32 RLIRBufferSize) callback,
  void                                                                                                      *userData,
  void                                                                                                      *pRLIRBuffer,
  HBA_UINT32                                                                                                RLIRBufferSize,
  HBA_HANDLE                                                                                                Handle,
  HBA_CALLBACKHANDLE                                                                                        *pCallbackHandle
);

Parameters

callback

Pointer to a callback routine to be called when the event occurs. Define your callback routine with this prototype:

void(*)(void *data, HBA_WWN adapterWWN, HBA_UINT32 eventType, void *pRLIRBuffer, HBA_UINT32 RLIRBufferSize)

When your callback routine is called, the following parameters are passed to it:

• data. Pointer to a buffer that contains data that you provided when registering this callback routine. You can use this data to correlate the event with the source of the event registration.
• adapterWWN. A 64-bit world-wide name (WWN) that uniquely identifies the host bus adapter (HBA) from which the adapter event is being reported. The callback routine is called whenever an adapter event occurs for this HBA. For a discussion of worldwide names, see the T11 committee's Fibre Channel HBA API specification.
• eventType. Indicates the event type. The values assigned to this member correspond to the values associated with the EVENT_TYPE_QUALIFIERS property qualifier. In particular, this member can have one of the following values: HBA_EVENT_LINK_UNKNOWN (a fabric link or topology change was detected by means other than a registered link incident report, or RLIR), or HBA_EVENT_LINK_INCIDENT (an RLIR has arrived).
• pRLIRBuffer. A buffer that contains the payload data of the RLIR associated with the event. If the RLIR payload exceeds the size of the buffer, then the data is truncated to the size of the buffer. The reported data is in big-endian format (that is, higher order bytes are in lower addresses).
• RLIRBufferSize. Indicates the size of the buffer at pRLIRBuffer.

userData

Pointer to a buffer that will be passed to the callback routine with each event. This data correlates the event with the source of the event registration.

pRLIRBuffer

Pointer to registered link incident report (RLIR) data that is passed to the callback routine with each occurrence of the event. This data is overwritten by the callback routine each time it is called.

RLIRBufferSize

Contains the size, in bytes, of the buffer at pRLIRBuffer.

Handle

Contains a value (returned by the routine HBA_OpenAdapter) that identifies the HBA for which event callbacks are requested.

pCallbackHandle

Contains an opaque identifier that you can pass to HBA_RemoveCallback to de-register the callback routine.

Return value

A value of type HBA_STATUS that indicates the status of the HBA. In particular, it returns one of the following values.

Remarks

Only RLIR events are reported. To stop event delivery, call HBA_RemoveCallback.

Requirements