Class ConnectParameters

Specifies the parameters for establishing a VNC connection.

Inheritance
System.Object
FreezableParametersObject
ConnectParameters
Inherited Members
Namespace: MarcusW.VncClient
Assembly: MarcusW.VncClient.dll
Syntax
public sealed class ConnectParameters : FreezableParametersObject

Fields

| Improve this Doc View Source

InfiniteReconnects

The value to specify unlimited reconnect attempts.

Declaration
public const int InfiniteReconnects = null
Field Value
Type Description
System.Int32

Properties

| Improve this Doc View Source

AllowSharedConnection

Gets or sets whether the server should leave other clients connected when this connection is established.

Declaration
public bool AllowSharedConnection { get; set; }
Property Value
Type Description
System.Boolean
| Improve this Doc View Source

AuthenticationHandler

Gets or sets the IAuthenticationHandler implementation that provides information for authenticating against the server.

Declaration
public IAuthenticationHandler AuthenticationHandler { get; set; }
Property Value
Type Description
IAuthenticationHandler
| Improve this Doc View Source

ConnectTimeout

Gets or sets the connect timeout.

Declaration
public TimeSpan ConnectTimeout { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

InitialOutputHandler

Gets or sets the handler for output events from the server, in case you want to set the handler from the start on.

Declaration
public IOutputHandler InitialOutputHandler { get; set; }
Property Value
Type Description
IOutputHandler
| Improve this Doc View Source

InitialRenderTarget

Gets or sets the target where received frames should be rendered to, in case you want to set the target from the start on.

Declaration
public IRenderTarget InitialRenderTarget { get; set; }
Property Value
Type Description
IRenderTarget
| Improve this Doc View Source

JpegQualityLevel

Gets or sets the JPEG quality level in percent (0 to 100).

Declaration
public int JpegQualityLevel { get; set; }
Property Value
Type Description
System.Int32
| Improve this Doc View Source

JpegSubsamplingLevel

Gets or sets the JPEG subsampling level.

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

MaxReconnectAttempts

Gets or sets the maximum number of reconnect attempts.

Declaration
public int MaxReconnectAttempts { get; set; }
Property Value
Type Description
System.Int32
Remarks

Set to -1 for not limit.

| Improve this Doc View Source

ReconnectDelay

Gets or sets the delay between a connection being interrupted and a reconnect starting.

Declaration
public TimeSpan ReconnectDelay { get; set; }
Property Value
Type Description
TimeSpan
| Improve this Doc View Source

RenderFlags

Gets or sets the flags that control, how the rendering to the target framebuffer should happen.

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

TransportParameters

Specifies the transport type and parameters to connect to.

Declaration
public TransportParameters TransportParameters { get; set; }
Property Value
Type Description
TransportParameters

Methods

| Improve this Doc View Source

GetDescendants()

Returns all referenced FreezableParametersObject descendants of this object or null, when there aren't any.

Declaration
protected override IEnumerable<FreezableParametersObject>? GetDescendants()
Returns
Type Description
System.Nullable<IEnumerable<FreezableParametersObject>>
Overrides
| Improve this Doc View Source

Validate()

Declaration
public override void Validate()
Overrides