T_Furcadia_Net_Options_ProxyOptions - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

ProxyOptions Class

This stuff is still in the planning stages. Any questions or Comments are welcome. [This is preliminary documentation and is subject to change.]

Configuration options for NetProxy

Inheritance Hierarchy

System.Object
  Furcadia.Net.Options.ClientOptions
    Furcadia.Net.Options.ProxyOptions
Namespace: Furcadia.Net.Options
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 43

Syntax

C#

public class ProxyOptions : ClientOptions

VB

Public Class ProxyOptions
	Inherits ClientOptions

VB Usage

Dim instance As ProxyOptions

C++

public ref class ProxyOptions : public ClientOptions

F#

type ProxyOptions =  
    class
        inherit ClientOptions
    end

The ProxyOptions type exposes the following members.

Constructors

 

Name Description
Public method ProxyOptions Default settings localhostport = 6700

furcprocess = "Furcadia.exe"

  Back to Top

Properties

 

Name Description
Public property CharacterIniFile Character Ini file to connect to the Game server with
Public property ConnectionRetries Gets or sets the connection retries.
Public property ConnectionTimeOut Gets or sets the connection time out.
Public property FurcadiaInstallPath Furcadia working folder path to the Client install we want to use
Public property FurcadiaProcess Furcadia Client executable
Public property GameServerHost Host name or IP of the game server (Inherited from ClientOptions.)
Public property GameServerPort Game server TCP Port (Inherited from ClientOptions.)
Public property LocalhostPort Localhost TCP port
Public property ProxyHost Host name or IP Address for the proxy server

Defaults to "localhost'

Public property ResetSettingTime time delay to reset furcadia settings when the furcadia client is launched.
Public property Standalone Allow the connection to stay open after the client drops?
  Back to Top

Methods

 

Name Description
Public method Equals Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected method Finalize Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public method GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Fields

 

Name Description
Protected field FurcadiaFilePaths Furcadia Paths File Path Structure. (Inherited from ClientOptions.)
Protected field FurcadiaUtilities Furcadia Utilities (Inherited from ClientOptions.)
  Back to Top

Extension Methods

 

Name Description
Public Extension Method AsDouble (Defined by ObjectExtensions.)
Public Extension Method AsInt16 (Defined by ObjectExtensions.)
Public Extension Method AsInt32 (Defined by ObjectExtensions.)
Public Extension Method AsInt64 (Defined by ObjectExtensions.)
Public Extension Method AsString (Defined by ObjectExtensions.)
  Back to Top

See Also

Reference

Furcadia.Net.Options Namespace

⚠️ **GitHub.com Fallback** ⚠️