T_Furcadia_Net_Proxy_ProxySession - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

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

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

Syntax

C#

public class ProxySession : NetProxy, 
	IDisposable

VB

Public Class ProxySession
	Inherits NetProxy
	Implements IDisposable

VB Usage

Dim instance As ProxySession

C++

public ref class ProxySession : public NetProxy, 
	IDisposable

F#

type ProxySession =  
    class
        inherit NetProxy
        interface IDisposable
    end

The ProxySession type exposes the following members.

Constructors

 

Name Description
Public method ProxySession() Initializes a new instance of the ProxySession class
Public method ProxySession(ProxyOptions) Initializes a new instance of the ProxySession class
  Back to Top

Properties

 

Name Description
Public property BanishList Gets the banish list.
Public property BanishName Current Name for Banish Operations We mirror Furcadia's Banish system for efficiency
Public property BufferCapacity Gets the buffer capacity. (Inherited from NetProxy.)
Public property ClientConnectPhase Current Connection Phase
Public property ClientStatus Client Connection status
Public property ConnectedFurre Connected Furre (Who we are)
Public property CurrentConnectionAttempt Gets the current connection attempt. (Inherited from NetProxy.)
Public property Dream Current Dream Information with Furre List
Public property EncoderPage Encodig

DEFAULT: Windows 1252 (Inherited from NetProxy.)

Public property FurcadiaClientIsRunning Gets a value indicating whether [the Furcadia lient is a running process]. (Inherited from NetProxy.)
Public property FurcadiaProcessID Gets the furcadia process identifier. (Inherited from NetProxy.)
Public property HasShare We have Dream Share or We are Dream owner
Public property InDream
Public property IsClientSocketConnected Gets a value indicating whether this instance is client socket connected. (Inherited from NetProxy.)
Public property IsServerSocketConnected Check our connection status to the game server (Inherited from NetProxy.)
Public property Options Gets or sets the options. (Inherited from NetProxy.)
Public property Player Current Triggering player
Public property ServerConnectPhase Current server connection phase
Public property ServerStatus Server Connection status
Public property StandAlone Allows the Furcadia Client to Disconnect from the session, allowing the session to remain connected to the game server
Public property ThroatTired ServerQueue Throat Tired Mode When set, a Timer is created to make us wait till the time is clear to resume.
  Back to Top

Methods

 

Name Description
Public method Connect Connect the Proxy to the Furcadia Game server (Overrides NetProxy.Connect().)
Public method DisconnectClientStream Disconnect from the Furcadia client (Inherited from NetProxy.)
Public method DisconnectServerAndClientStreams Disconnect from Furcadia and notify delegates. (Overrides NetProxy.DisconnectServerAndClientStreams().)
Public method Dispose implementation of Dispose pattern callable by consumers. (Overrides NetProxy.Dispose().)
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 GetEnumInt(T)
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.)
Public method IsConnectedCharacter() Are we the current executing character?
Public method IsConnectedCharacter(Furre) Is the target furre the connected characyer?
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method ParseServerChannel Parse Channel Data
Public method ParseServerData Parse Server Data
Protected method SendError send errors to the error handler (Inherited from NetProxy.)
Public method 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"

Public method SendToClient(String) Send a raw instruction to the client (Overrides NetProxy.SendToClient(String).)
Public method SendToClient(INetMessage)

(Inherited from NetProxy.)

Public method SendToServer(String) Send a raw instruction to Server through the Load Balancer (Overrides NetProxy.SendToServer(String).)
Public method SendToServer(INetMessage)

(Inherited from NetProxy.)

Public method TextToServer Text Channel Prefixes (shout,whisper emote, Raw Server command) default to say or "normal spoken command"
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

Name Description
Protected event ClientConnected (Inherited from NetProxy.)
Public event ClientData2 This is triggered when the Client sends data to the server. Expects a return value. (Overrides NetProxy.ClientData2.)
Protected event ClientDisconnected This is triggered when the Client Disconnects (Inherited from NetProxy.)
Protected event ClientExited Occurs when the furcadia client exits. (Inherited from NetProxy.)
Public event ClientStatusChanged Track the Furcadia Client status
Public event Error This is triggered when a handled Exception is thrown. (Inherited from NetProxy.)
Public event ProcessServerChannelData Process Display Text and Channels
Public event ProcessServerInstruction
Public event ServerConnected (Inherited from NetProxy.)
Public event ServerData2 This is triggered when the Server sends data to the client. Doesn't expect a return value. (Overrides NetProxy.ServerData2.)
Public event ServerDisconnected This is triggered when the Server Disconnects (Inherited from NetProxy.)
Public event ServerStatusChanged Track the Server Status
  Back to Top

Fields

 

Name Description
Protected field FurcadiaUtilities Furcadia Utilities (Inherited from NetProxy.)
Public field Repq
Public field TroatTiredEventHandler The troat tired event handler
  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

See Also

Reference

Furcadia.Net.Proxy Namespace

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