Interface IRfbProtocolImplementation

Provides access to different elements of a RFB protocol implementation.

Namespace: MarcusW.VncClient.Protocol

Assembly: MarcusW.VncClient.dll

Syntax

public interface IRfbProtocolImplementation

Methods

CreateEncodingTypesCollection(RfbConnectionContext)

Creates a new collection of all supported IEncodingTypes.

Declaration

IImmutableSet<IEncodingType> CreateEncodingTypesCollection(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IImmutableSet<IEncodingType>	An immutable set with all supported encoding types.

Remarks

Make sure the encoding types are newly instantiated on each call, because it's not guaranteed that they can safely be used across multiple connections simultaneously.

CreateJpegDecoder(RfbConnectionContext)

Creates a new IJpegDecoder.

Declaration

IJpegDecoder CreateJpegDecoder(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IJpegDecoder	A new instance of the jpeg decoder.

CreateMessageReceiver(RfbConnectionContext)

Creates a new IRfbMessageReceiver.

Declaration

IRfbMessageReceiver CreateMessageReceiver(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IRfbMessageReceiver	A new instance of the message receiver.

CreateMessageSender(RfbConnectionContext)

Creates a new IRfbMessageSender.

Declaration

IRfbMessageSender CreateMessageSender(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IRfbMessageSender	A new instance of the message sender.

CreateMessageTypesCollection(RfbConnectionContext)

Creates a new collection of all supported IMessageTypes.

Declaration

IImmutableSet<IMessageType> CreateMessageTypesCollection(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IImmutableSet<IMessageType>	An immutable set with all supported message types.

Remarks

Make sure the message types are newly instantiated on each call, because it's not guaranteed that they can safely be used across multiple connections simultaneously.

CreateRfbHandshaker(RfbConnectionContext)

Creates a new IRfbHandshaker.

Declaration

IRfbHandshaker CreateRfbHandshaker(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IRfbHandshaker	A new instance of the RFB handshaker.

CreateRfbInitializer(RfbConnectionContext)

Creates a new IRfbInitializer.

Declaration

IRfbInitializer CreateRfbInitializer(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IRfbInitializer	A new instance of the RFB initializer.

CreateSecurityTypesCollection(RfbConnectionContext)

Creates a new collection of all supported ISecurityTypes.

Declaration

IImmutableSet<ISecurityType> CreateSecurityTypesCollection(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IImmutableSet<ISecurityType>	An immutable set with all supported security types.

Remarks

Make sure the security types are newly instantiated on each call, because it's not guaranteed that they can safely be used across multiple connections simultaneously.

CreateStateObject(RfbConnectionContext)

Creates a new IRfbProtocolState state object.

Declaration

IRfbProtocolState CreateStateObject(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IRfbProtocolState	A new state object.

CreateTransportConnector(RfbConnectionContext)

Creates a new ITransportConnector.

Declaration

ITransportConnector CreateTransportConnector(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
ITransportConnector	A new instance of the transport connector.

CreateZLibInflater(RfbConnectionContext)

Creates a new IZLibInflater.

Declaration

IZLibInflater CreateZLibInflater(RfbConnectionContext context)

Parameters

Type	Name	Description
RfbConnectionContext	context	Details about the associated connection.

Returns

Type	Description
IZLibInflater	A new instance of the zlib inflater.