T_Furcadia_Net_DirectConnection_ClientBase - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

ClientBase Class

This stuff is still in the planning stages. Any questions or Comments are welcome. [This is preliminary documentation and is subject to change.]

NetConnection Derived from ProxyBase for Stand alone connections

Inheritance Hierarchy

System.Object
  Furcadia.Net.DirectConnection.ClientBase
    Furcadia.Net.DirectConnection.NetConnection
Namespace: Furcadia.Net.DirectConnection
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 43

Syntax

C#

public class ClientBase

VB

Public Class ClientBase

VB Usage

Dim instance As ClientBase

C++

public ref class ClientBase

F#

type ClientBase =  class end

The ClientBase type exposes the following members.

Constructors

 

Name Description
Public method ClientBase() Default Constructor Load furcadia defaults from %appData%\settings.ini
Public method ClientBase(Int32) Initializes a new instance of the ClientBase class
Public method ClientBase(IPAddress, Int32) Initializes a new instance of the ClientBase class
Public method ClientBase(String, Int32) Initializes a new instance of the ClientBase class
  Back to Top

Properties

 

Name Description
Public propertyStatic member BufferCapacity
Public propertyStatic member EncoderPage Set the Encoder to win 1252 encoding
Public property EndPoint Game Server IP/Port
Public property IsServerConnected Proxy is connected, or not.
  Back to Top

Methods

 

Name Description
Public method Connect Connects to the Furcadia Server and starts the mini proxy.
Public method Dispose() Releases all resources used by the ClientBase
Protected method Dispose(Boolean) Releases the unmanaged resources used by the ClientBase and optionally releases the managed resources
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 GetHashCode Serves as the default hash function. (Inherited from Object.)
Public method GetType Gets the Type of the current instance. (Inherited from Object.)
Protected method MemberwiseClone Creates a shallow copy of the current Object. (Inherited from Object.)
Public method SendServer(String) Sends Data to the Game server
Public method SendServer(INetMessage) Sends the text to the game server
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

Name Description
Public event Connected This is triggered when the
Public event Error This is triggered when a handled Exception is thrown.
Public event ServerData This is triggered when the Server sends data to the client. Doesn't expect a return value.
Public event ServerDisConnected This is triggered when the Server Disconnects
  Back to Top

Fields

 

Name Description
Protected field FurcadiaUtilities Furcadia Utilities
Public field FurcPath Furcadia Path Collection
  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.DirectConnection Namespace

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