msg Package

msg Package

connector_factory Module

Protocol connector factory

class vmware.vapi.protocol.client.msg.connector_factory.ProtocolConnectorFactory

Bases: object

Protocol connector factory

Protocol connector factory init

get_connector(protocol, *args, **kwargs)

Create protocol connector

Parameters:

• protocol (str) – protocol name
• args (tuple) – position parameters to protocol connector constructor
• kwargs (dict) – key parameters to protocol connector constructor

Return type:

vmware.vapi.protocol.client.connector.Connector

Returns:

Connector object

generic_connector Module

Generic client connector

class vmware.vapi.protocol.client.msg.generic_connector.GenericConnector(rpc_provider, api_provider)

Bases: vmware.vapi.protocol.client.connector.Connector

A generic protocol connector

Generic protocol connector init

Parameters:

• rpc_provider (vmware.vapi.protocol.client.rpc.provider.RpcProvider) – rpc provider object
• api_provider (vmware.vapi.core.ApiProvider) – api provider object

connect()

rpc provider connect

disconnect()

rpc provider disconnect

get_api_provider()

get api provider

Return type:vmware.vapi.core.ApiProvider Returns:api provider

new_context()

create new execution context object

Return type:vmware.vapi.core.ExecutionContext Returns:execution context

set_application_context(ctx)

Set the application context

All the subsequent calls made using this connector will use this as the application context in the ExecutionContext

Parameters:ctx (vmware.vapi.core.ApplicationContext) – New application context

set_security_context(ctx)

Set the security context

All the subsequent calls made using this connector will use this as the security context in the ExecutionContext

Parameters:ctx (vmware.vapi.core.SecurityContext) – New security context

json_connector Module

Json client handler

class vmware.vapi.protocol.client.msg.json_connector.JsonClientProvider(rpc_provider)

Bases: vmware.vapi.core.ApiProvider

Json rpc client provider

Json rpc client provider init

Parameters:rpc_provider (vmware.vapi.protocol.client.rpc.provider.RpcProvider) – rpc provider object

invoke(service_id, operation_id, input_value, ctx)

Invokes the specified method using the input value and the the execution context provided

Parameters:

• service_id (str) – Service identifier
• operation_id (str) – Operation identifier
• input_value (vmware.vapi.data.value.DataValue) – method input parameters
• ctx (vmware.vapi.core.ExecutionContext) – execution context object

Return type:

vmware.vapi.core.MethodResult

Returns:

method result object

vmware.vapi.protocol.client.msg.json_connector.get_protocol_connector(rpc_provider)

Get protocol connector

Parameters:rpc_provider (vmware.vapi.protocol.client.rpc.provider.RpcProvider) – rpc provider object Return type:vmware.vapi.protocol.client.connector.Connector Returns:json rpc connector object