Click or drag to resize

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.]

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.Net.DirectConnectionClientBase
    Furcadia.Net.ProxyNetProxy

Namespace:  Furcadia.Net.DirectConnection
Assembly:  FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 59
Syntax
public class ClientBase : IDisposable

The ClientBase type exposes the following members.

Constructors
  NameDescription
Public methodClientBase
Connect to game server with default settings
Public methodClientBase(Int32)
Initializes a new instance of the ClientBase class.
Public methodClientBase(BaseConnectionOptions)
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
Gets the buffer capacity.
Public propertyCurrentConnectionAttempt
Gets the current connection attempt.
Public propertyIsServerSocketConnected
Check our connection status to the game server
Public propertyOptions
Gets or sets the options.
Top
Methods
  NameDescription
Public methodConnect
Connects to the Furcadia game server
Public methodDisconnect
Disconnect from the Furcadia game-server and Furcadia client
Public methodDispose
Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged 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 methodSendError
send errors to the error handler
Public methodSendToServer(String)
Sends to server.
Public methodSendToServer(INetMessage)
Sends to server.
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventError
This is triggered when a handled Exception is thrown.
Public eventServerConnected
Occurs when [server connected].
Public eventServerData2
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
Top
Extension Methods
  NameDescription
Public Extension MethodAsDouble
Ases the double.
(Defined by ObjectExtensions.)
Public Extension MethodAsInt16
converts an object to 16 bit integer
(Defined by ObjectExtensions.)
Public Extension MethodAsInt32
Ases the int32.
(Defined by ObjectExtensions.)
Public Extension MethodAsInt64
Ases the int64.
(Defined by ObjectExtensions.)
Public Extension MethodAsString
Ases the string.
(Defined by ObjectExtensions.)
Top
Remarks