T_Furcadia_Net_NetProxy - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

NetProxy Class

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

Furcadia base proxy connect between Client and Server. This is a low level class that handles the raw connections and furcadia proxy/firewall settings. We don't have TLS/SSL handling here, so therefore, Furcadia Settings for this are disabled

Inheritance Hierarchy

System.Object
  Furcadia.Net.NetProxy
    Furcadia.Net.Proxy.ProxySession
Namespace: Furcadia.Net
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 43

Syntax

C#

public class NetProxy : IDisposable

VB

Public Class NetProxy
	Implements IDisposable

VB Usage

Dim instance As NetProxy

C++

public ref class NetProxy : IDisposable

F#

type NetProxy =  
    class
        interface IDisposable
    end

The NetProxy type exposes the following members.

Constructors

 

Name Description
Public method NetProxy() Connect to game server with default settings
Public method NetProxy(Int32) Initializes a new instance of the NetProxy class
Public method NetProxy(ProxyOptions) Connect to Furcadia with Proxy Options
Public method NetProxy(Int32, Int32) Initializes a new instance of the NetProxy class
Public method NetProxy(String, Int32) Initializes a new instance of the NetProxy class
Public method NetProxy(String, Int32, Int32) Connect to the Game serer by Host name to IP address
  Back to Top

Properties

 

Name Description
Public property BufferCapacity Gets the buffer capacity.
Public property CurrentConnectionAttempt Gets the current connection attempt.
Public property EncoderPage Encodig

DEFAULT: Windows 1252

Public property FurcadiaClientIsRunning Gets a value indicating whether [the Furcadia lient is a running process].
Public property FurcadiaProcessID Gets the furcadia process identifier.
Public property IsClientSocketConnected Gets a value indicating whether this instance is client socket connected.
Public property IsServerSocketConnected Check our connection status to the game server
Public property Options Gets or sets the options.
  Back to Top

Methods

 

Name Description
Public methodStatic member CloseFurcadiaClient Disconnects the furcadia client and Closes the application
Public method Connect Connects to the Furcadia Server and starts the mini proxy.
Public method DisconnectClientStream Disconnect from the Furcadia client
Public method DisconnectServerAndClientStreams Disconnect from the Furcadia gameserver and Furcadia client
Public method Dispose Releases all resources used by the NetProxy
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.)
Protected method SendError send errors to the error handler
Public method SendToClient(String)
Public method SendToClient(INetMessage)
Public method SendToServer(String)
Public method SendToServer(INetMessage)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

Name Description
Protected event ClientConnected
Public event ClientData2 This is triggered when the Client sends data to the server. Expects a return value.
Protected event ClientDisconnected This is triggered when the Client Disconnects
Protected event ClientExited Occurs when the furcadia client exits.
Public event Error This is triggered when a handled Exception is thrown.
Public event ServerConnected
Public event ServerData2 This is triggered when the Server sends data to the client. Doesn't expect a return value.
Public event ServerDisconnected This is triggered when the Server Disconnects
  Back to Top

Fields

 

Name Description
Protected field FurcadiaUtilities Furcadia Utilities
  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

Remarks

See Also

Reference

Furcadia.Net Namespace

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