Class RfbConnectionContext

Holds multiple connection-related objects and acts as a central place to provide the protocol implementation classes access to them.

Inheritance
System.Object
RfbConnectionContext
Namespace: MarcusW.VncClient.Protocol
Assembly: MarcusW.VncClient.dll
Syntax
public class RfbConnectionContext : object
Remarks

This is just a container class that does not implement any complex logic. Remember that some of the properties might be uninitialized during early stages of the protocol.

Properties

| Improve this Doc View Source

Connection

Gets the RfbConnection to which this connection belongs to.

Declaration
public RfbConnection Connection { get; }
Property Value
Type Description
RfbConnection
| Improve this Doc View Source

ConnectionDetails

Gets a RfbConnectionContext.ConnectionDetailsAccessor which provides write access to some details properties on the RfbConnection object.

Declaration
public RfbConnectionContext.ConnectionDetailsAccessor ConnectionDetails { get; }
Property Value
Type Description
RfbConnectionContext.ConnectionDetailsAccessor
| Improve this Doc View Source

JpegDecoder

Gets the IJpegDecoder for this connection.

Declaration
public IJpegDecoder JpegDecoder { get; }
Property Value
Type Description
IJpegDecoder
| Improve this Doc View Source

MessageReceiver

Gets the IRfbMessageReceiver for this connection.

Declaration
public IRfbMessageReceiver MessageReceiver { get; }
Property Value
Type Description
IRfbMessageReceiver
| Improve this Doc View Source

MessageSender

Gets the IRfbMessageSender for this connection.

Declaration
public IRfbMessageSender MessageSender { get; }
Property Value
Type Description
IRfbMessageSender
| Improve this Doc View Source

State

Gets the protocol state object.

Declaration
public IRfbProtocolState State { get; }
Property Value
Type Description
IRfbProtocolState
| Improve this Doc View Source

SupportedEncodingTypes

Gets the encoding types that are supported by the client.

Declaration
public IImmutableSet<IEncodingType>? SupportedEncodingTypes { get; }
Property Value
Type Description
System.Nullable<IImmutableSet<IEncodingType>>
| Improve this Doc View Source

SupportedMessageTypes

Gets the message types that are supported by the client.

Declaration
public IImmutableSet<IMessageType>? SupportedMessageTypes { get; }
Property Value
Type Description
System.Nullable<IImmutableSet<IMessageType>>
| Improve this Doc View Source

SupportedSecurityTypes

Gets the security types that are supported by the client.

Declaration
public IImmutableSet<ISecurityType>? SupportedSecurityTypes { get; }
Property Value
Type Description
System.Nullable<IImmutableSet<ISecurityType>>
| Improve this Doc View Source

Transport

Gets the current transport layer used by the protocol. Please note, that this might be replaced with tunnel transports during the handshake procedure.

Declaration
public ITransport Transport { get; }
Property Value
Type Description
ITransport
| Improve this Doc View Source

ZLibInflater

Gets the IZLibInflater for this connection.

Declaration
public IZLibInflater ZLibInflater { get; }
Property Value
Type Description
IZLibInflater

Methods

| Improve this Doc View Source

GetState<TState>()

Casts the state object to and returns it.

Declaration
public TState GetState<TState>()
    where TState : class, IRfbProtocolState
Returns
Type Description
TState

The casted state.
Type Parameters
Name Description
TState

The type of the state object that implements IRfbProtocolState.