NetProxy Class

Furcadia Framework

NetProxy Class

Furcadia Framework For Third Party Programs
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

SystemObject  Furcadia.NetNetProxy
    Furcadia.Net.ProxyProxySession

Namespace:  Furcadia.Net
Assembly:  FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 42
Syntax

public class NetProxy : IDisposable
Public Class NetProxy
	Implements IDisposable

Dim instance As NetProxy
public ref class NetProxy : IDisposable
type NetProxy =  
    class
        interface IDisposable
    end

The NetProxy type exposes the following members.

Constructors

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

  NameDescription
Public propertyBufferCapacity
Gets the buffer capacity.
Public propertyCurrentConnectionAttempt
Gets the current connection attempt.
Public propertyEncoderPage
Encodig

DEFAULT: Windows 1252

Public propertyFurcadiaClientIsRunning
Gets a value indicating whether [the Furcadia lient is a running process].
Public propertyFurcadiaProcessID
Gets the furcadia process identifier.
Public propertyIsClientSocketConnected
Gets a value indicating whether this instance is client socket connected.
Public propertyIsServerSocketConnected
Check our connection status to the game server
Public propertyOptions
Gets or sets the options.
Top
Methods

  NameDescription
Public methodClientDisconnect
Disconnect from the Furcadia client
Public methodCloseClient
Disconnects the furcadia client and Closes the application
Public methodConnect
Connects to the Furcadia Server and starts the mini proxy.
Public methodDisconnect
Disconnect from the Furcadia gameserver and Furcadia client
Public methodDispose
Releases all resources used by the NetProxy
Public methodEquals
Determines whether the specified object is equal to the current object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as the default hash function.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodSendError
send errors to the error handler
Public methodSendToClient(String)
Public methodSendToClient(INetMessage)
Public methodSendToServer(String)
Public methodSendToServer(INetMessage)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Protected eventClientConnected
Public eventClientData2
This is triggered when the Client sends data to the server. Expects a return value.
Protected eventClientDisconnected
This is triggered when the Client Disconnects
Protected eventClientExited
Occurs when the furcadia client exits.
Public eventError
This is triggered when a handled Exception is thrown.
Protected eventServerConnected
Public eventServerData2
This is triggered when the Server sends data to the client. Doesn't expect a return value.
Public eventServerDisconnected
This is triggered when the Server Disconnects
Top
Fields

  NameDescription
Protected fieldFurcadiaUtilities
Furcadia Utilities
Top
Extension Methods

  NameDescription
Public Extension MethodAsDouble (Defined by ObjectExtensions.)
Public Extension MethodAsInt16 (Defined by ObjectExtensions.)
Public Extension MethodAsInt32 (Defined by ObjectExtensions.)
Public Extension MethodAsInt64 (Defined by ObjectExtensions.)
Public Extension MethodAsString (Defined by ObjectExtensions.)
Top
Remarks

See Also

Reference