Click or drag to resize

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

Namespace:  Furcadia.Net.Proxy
Assembly:  FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 59
Syntax
public class NetProxy : ClientBase, IDisposable

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 propertyCurrentConnectionAttempt
Gets the current connection attempt.
(Inherited from ClientBase.)
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
(Inherited from ClientBase.)
Public propertyOptions
Gets or sets the options.
Top
Methods
  NameDescription
Public methodCloseFurcadiaClient
Disconnects the furcadia client and Closes the application
Public methodConnect
Connects to the Furcadia Server and starts the mini proxy.
(Overrides ClientBaseConnect.)
Public methodDisconnect
Disconnect from the Furcadia game-server and Furcadia client
(Inherited from ClientBase.)
Public methodDisconnectClientStream
Disconnect from the Furcadia client
Public methodDisconnectServerAndClientStreams
Disconnect from the Furcadia game-server and Furcadia client
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources.
(Overrides ClientBaseDispose.)
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.)
Public methodSendError
send errors to the error handler
(Inherited from ClientBase.)
Public methodSendToClient(String)
Public methodSendToClient(INetMessage)
Public methodSendToServer(String)
Sends to server.
(Inherited from ClientBase.)
Public methodSendToServer(INetMessage)
Sends to server.
(Inherited from ClientBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Protected eventClientConnected
Occurs when [client connected].
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.
(Inherited from ClientBase.)
Public eventServerConnected
Occurs when [server connected].
(Overrides ClientBaseServerConnected.)
Public eventServerData2
This is triggered when the Server sends data to the client. Doesn't expect a return value.
(Inherited from ClientBase.)
Public eventServerDisconnected
This is triggered when the Server Disconnects
(Overrides ClientBaseServerDisconnected.)
Top
Fields
  NameDescription
Protected fieldFurcadiaUtilities
Furcadia Utilities
(Inherited from ClientBase.)
Top
Extension Methods
  NameDescription
Public Extension MethodAsDouble
Ases the double.
(Defined by ObjectExtensions.)
Public Extension MethodAsInt16
converts an object to 16 bit integer
(Defined by ObjectExtensions.)
Public Extension MethodAsInt32
Ases the int32.
(Defined by ObjectExtensions.)
Public Extension MethodAsInt64
Ases the int64.
(Defined by ObjectExtensions.)
Public Extension MethodAsString
Ases the string.
(Defined by ObjectExtensions.)
Top
Remarks