Module protocol

Structs

AllOffersDelivered

ChannelId

CloseChannel

CloseReservedChannel

CloseReservedChannelResponse

ConnectionId

ConnectionState

Possible values for the VersionResponse::connection_state field.

FeatureFlags

GpadlBody

GpadlCreated

GpadlHeader

GpadlId

GpadlTeardown

GpadlTorndown

HvsockParametersVersion

Possible values for the PipeUserDefinedParameters::pipe_type field.

HvsockUserDefinedParameters

InitiateContact

InitiateContact2

Initiate contact message used with FeatureFlags::CLIENT_ID when the feature is supported (Copper and above).

MessageHeader

The header of a vmbus message.

MessageType

Represents the message type value that identifies a vmbus protocol message.

ModifyChannel

ModifyChannelResponse

ModifyConnection

ModifyConnectionResponse

OfferChannel

OfferFlags

OpenChannel

OpenChannel2

Open channel message used if FeatureFlags::GUEST_SPECIFIED_SIGNAL_PARAMETERS or FeatureFlags::CHANNEL_INTERRUPT_REDIRECTION is supported.

OpenChannelFlags

OpenReservedChannel

OpenResult

Pause

PauseResponse

PipeType

Possible values for the PipeUserDefinedParameters::pipe_type field.

PipeUserDefinedParameters

First 4 bytes of user_defined for named pipe offers.

RelIdReleased

RequestOffers

RescindChannelOffer

Resume

TargetInfo

Helper struct to interpret the InitiateContact::interrupt_page_or_target_info field.

TlConnectRequest

TlConnectRequest2

TlConnectResult

Unload

UnloadComplete

UserDefinedData

User-defined data provided by a device as part of an offer or open request.

VersionResponse

VersionResponse2

Version response message used by Version::Copper and above. N.B. The server will only send this version if the requested version is Version::Copper or above and the version is supported. For unsupported versions, the original VersionResponse is always sent.

Enums

Message

Represents a parsed vmbus protocol message.

ParseError

An error that occurred while parsing a vmbus protocol message.

Version

Constants

HEADER_SIZE

MAX_MESSAGE_SIZE

STATUS_CONNECTION_REFUSED

STATUS_SUCCESS

STATUS_UNSUCCESSFUL

VMBUS_MESSAGE_REDIRECT_CONNECTION_ID

VP_INDEX_DISABLE_INTERRUPT

Target VP index value that indicates that interrupts should be disabled for the channel.

Traits

VmbusMessage

Trait implemented on all protocol message structs by the vmbus_message! macro.

Functions

make_version