Edit

EVT_VMB_CHANNEL_OPENED callback function (vmbuskernelmodeclientlibapi.h)

  • Article

[Some information relates to pre-released product which may be substantially modified before it's commercially released. Microsoft makes no warranties, express or implied, with respect to the information provided here.]

The EvtVmbChannelOpened callback function is invoked when the client endpoint in the guest virtual machine opens a channel which has been offered to it.

Syntax

EVT_VMB_CHANNEL_OPENED EvtVmbChannelOpened;

NTSTATUS EvtVmbChannelOpened(
  [in] VMBCHANNEL Channel
)
{...}

Parameters

[in] Channel

The channel that the guest virtual machine opens.

Return value

EvtVmbChannelClosed returns a status code.

Remarks

After a channel is created, a client driver can specify callback functions for state changes, including EvtVmbChannelOpened, by using the VMB_CHANNEL_STATE_CHANGE_CALLBACKS_INIT function.

After a channel has been
configured, the Kernel Mode Client Library (KMCL) client calls the VmbChannelEnable function. On the host, this function offers a channel to the guest. On the guest, this function accepts an existing offer or waits for such an offer to arrive. When a channel is opened, KMCL invokes the EvtVmbChannelOpened callback function.
After this callback finishes, the channel is in the open state.

Before this callback function is invoked, packets can be queued, but they cannot be sent.

If the client driver returns a failure status code, the channel rolls back to a state where no traffic flows.

Requirements

Requirement Value
Target Platform Windows
Header vmbuskernelmodeclientlibapi.h (include VmbusKernelModeClientLibApi.h)
IRQL PASSIVE_LEVEL

See also

VMB_CHANNEL_STATE_CHANGE_CALLBACKS_INIT

VmbChannelEnable