ClientBase Class

Furcadia Framework

ClientBase Class

Furcadia Framework For Third Party Programs
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

SystemObject  Furcadia.Net.DirectConnectionClientBase
    Furcadia.Net.DirectConnectionNetConnection

Namespace:  Furcadia.Net.DirectConnection
Assembly:  FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 42
Syntax

public class ClientBase
Public Class ClientBase

Dim instance As ClientBase
public ref class ClientBase
type ClientBase =  class end

The ClientBase type exposes the following members.

Constructors

  NameDescription
Public methodClientBase
Default Constructor

Load furcadia defaults from %appData%\settings.ini

Public methodClientBase(Int32)
Initializes a new instance of the ClientBase class
Public methodClientBase(IPAddress, Int32)
Initializes a new instance of the ClientBase class
Public methodClientBase(String, Int32)
Initializes a new instance of the ClientBase class
Top
Properties

  NameDescription
Public propertyStatic memberBufferCapacity
Public propertyStatic memberEncoderPage
Set the Encoder to win 1252 encoding
Public propertyEndPoint
Game Server IP/Port
Public propertyIsServerConnected
Proxy is connected, or not.
Top
Methods

  NameDescription
Public methodConnect
Connects to the Furcadia Server and starts the mini proxy.
Public methodDispose
Releases all resources used by the ClientBase
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the ClientBase and optionally releases the managed resources
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 methodSendServer(String)
Sends Data to the Game server
Public methodSendServer(INetMessage)
Sends the text to the game server
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events

  NameDescription
Public eventConnected
This is triggered when the
Public eventError
This is triggered when a handled Exception is thrown.
Public eventServerData
This is triggered when the Server sends data to the client. Doesn't expect a return value.
Public eventServerDisConnected
This is triggered when the Server Disconnects
Top
Fields

  NameDescription
Protected fieldFurcadiaUtilities
Furcadia Utilities
Public fieldFurcPath
Furcadia Path Collection
Top
Extension Methods

  NameDescription
Public Extension MethodAsDouble (Defined by ObjectExtensions.)
Public Extension MethodAsInt16 (Defined by ObjectExtensions.)
Public Extension MethodAsInt32 (Defined by ObjectExtensions.)
Public Extension MethodAsInt64 (Defined by ObjectExtensions.)
Public Extension MethodAsString (Defined by ObjectExtensions.)
Top
See Also

Reference