ProxySession Class

This stuff is still in the planning stages. Any questions or Comments are welcome.

[This is preliminary documentation and is subject to change.]

This Instance handles the current Furcadia Session.

Part1: Manage MonkeySpeak Engine Start,Stop,Restart. System Variables, MonkeySpeak Execution Triggers

Part2: Furcadia Proxy Controls, In/Out Ports, Host, Character Ini file. Connect, Disconnect, Reconnect

Part2a: Proxy Functions do link to Monkey Speak trigger execution

Part3: This Class Links loosely to the GUI

Inheritance Hierarchy

SystemObject
Furcadia.Net.ProxyProxySession

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

Syntax

C++

Copy

public class ProxySession : IDisposable

Public Class ProxySession
	Implements IDisposable

Dim instance As ProxySession

public ref class ProxySession : IDisposable

type ProxySession =  
    class
        interface IDisposable
    end

The ProxySession type exposes the following members.

Constructors

	Name	Description
	ProxySession	Initializes a new instance of the ProxySession class
	ProxySession(ProxyOptions)	Initializes a new instance of the ProxySession class

Top

Properties

	Name	Description
	BanishList	Gets the banish list.
	BanishName	Current Name for Banish Operations We mirror Furcadia's Banish system for efficiency
	ClientConnectPhase	Current Connection Phase
	ClientStatus	Client Connection status
	ConnectedFurre	Connected Furre (Who we are)
	ConnectedFurreId	Gets or sets the connected furre identifier.
	ConnectedFurreName	Gets or sets the name of the connected furre.
	Dream	Current Dream Information with Furre List
	FurcadiaClientIsRunning	Gets a value indicating whether [furcadia client is running].
	Furres	Gets the furres.
	HasShare	We have Dream Share or We are Dream owner
	InDream
	IsClientSocketConnected	Gets a value indicating whether this instance is client socket connected.
	IsServerSocketConnected	Gets a value indicating whether the Proxy socket is connected to the game server
	Options	Gets or sets the options.
	Player	Current Triggering player
	Proxy	Gets the proxy.
	ServerConnectPhase	Current server connection phase
	ServerStatus	Server Connection status
	StandAlone	Allows the Furcadia Client to Disconnect from the session, allowing the session to remain connected to the game server
	ThroatTired	ServerQueue Throat Tired Mode When set, a Timer is created to make us wait till the time is clear to resume.

Top

Methods

	Name	Description
	CloseFurcadiaClient	Closes the furcadia client.
	Connect	Connect the Proxy to the Furcadia Game server
	Disconnect	Disconnects this instance.
	Dispose	implementation of Dispose pattern callable by consumers.
	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.)
	FormatTextToServer	Text Channel Prefixes (shout,whisper emote, Raw Server command) default to say or "normal spoken command"
	GetEnumIntT
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IsConnectedCharacter	Are we the current executing character?
	IsConnectedCharacter(IFurre)	Is the target furre the connected characyer?
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	OnThroatTiredTrigger	Called when [throat tired trigger].
	ParseServerChannel	Parse Channel Data
	ParseServerData	Parse Server Data
	SendError	send errors to the error handler
	SendFormattedTextToServer	Format basic furcadia commands and send to server We also mirror the client to server banish system. This maybe a good place to place Proxy/Bot commands for controls default to say or "normal spoken command"
	SendToClient	Send a raw instruction to the client
	SendToServer	Send a raw instruction to Server through the Load Balancer
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Top

Events

	Name	Description
	ClientData2	This is triggered when the Client sends data to the server. Expects a return value.
	ClientDisconnected	This is triggered when the Server Disconnects
	ClientStatusChanged	Track the Furcadia Client status
	Error	This is triggered when a handled Exception is thrown.
	ProcessServerChannelData	Process Display chanObject.ChannelText and Channels
	ProcessServerInstruction
	ServerConnected	Occurs when [server connected].
	ServerData2	Occurs when [server data2].
	ServerDisconnected	This is triggered when the Server Disconnects
	ServerStatusChanged	Track the Server Status

Top

Fields

	Name	Description
	Repq
	TroatTiredEventHandler	The troat tired event handler

Top

Extension Methods

	Name	Description
	AsDouble	Ases the double. (Defined by ObjectExtensions.)
	AsInt16	converts an object to 16 bit integer (Defined by ObjectExtensions.)
	AsInt32	Ases the int32. (Defined by ObjectExtensions.)
	AsInt64	Ases the int64. (Defined by ObjectExtensions.)
	AsString	Ases the string. (Defined by ObjectExtensions.)

Top

Reference

Furcadia.Net.Proxy Namespace