NetProxy Class

FFF3PP

previous page next page

Furcadia Framework For Third Party Programs

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

SystemObject Furcadia.NetNetProxy
Furcadia.Net.ProxyProxySession

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

Syntax

C++

Copy

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

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

Top

Properties

	Name	Description
	BufferCapacity	Gets the buffer capacity.
	CurrentConnectionAttempt	Gets the current connection attempt.
	EncoderPage	Encodig DEFAULT: Windows 1252
	FurcadiaClientIsRunning	Gets a value indicating whether [the Furcadia lient is a running process].
	FurcadiaProcessID	Gets the furcadia process identifier.
	IsClientSocketConnected	Gets a value indicating whether this instance is client socket connected.
	IsServerSocketConnected	Check our connection status to the game server
	Options	Gets or sets the options.

Top

Methods

	Name	Description
	CloseFurcadiaClient	Disconnects the furcadia client and Closes the application
	Connect	Connects to the Furcadia Server and starts the mini proxy.
	DisconnectClientStream	Disconnect from the Furcadia client
	DisconnectServerAndClientStreams	Disconnect from the Furcadia gameserver and Furcadia client
	Dispose	Releases all resources used by the NetProxy
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	SendError	send errors to the error handler
	SendToClient(String)
	SendToClient(INetMessage)
	SendToServer(String)
	SendToServer(INetMessage)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

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

Top

Fields

	Name	Description
	FurcadiaUtilities	Furcadia Utilities

Top

Extension Methods

	Name	Description
	AsDouble	(Defined by ObjectExtensions.)
	AsInt16	(Defined by ObjectExtensions.)
	AsInt32	(Defined by ObjectExtensions.)
	AsInt64	(Defined by ObjectExtensions.)
	AsString	(Defined by ObjectExtensions.)

Top

Remarks

Reference

Furcadia.Net Namespace

Send comments on this topic to Lead Developer Gerolkae

previous page start next page