PounceClient Class

FFF3PP

PounceClient Class

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

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

Generic Class to use the Pounce server
Inheritance Hierarchy
SystemObject  Furcadia.Net.PouncePounceConnection
    Furcadia.Net.PouncePounceClient

Namespace:  Furcadia.Net.Pounce
Assembly:  FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 44
Syntax
public class PounceClient : PounceConnection, 
	IDisposable
Public Class PounceClient
	Inherits PounceConnection
	Implements IDisposable

Dim instance As PounceClient
public ref class PounceClient : public PounceConnection, 
	IDisposable
type PounceClient =  
    class
        inherit PounceConnection
        interface IDisposable
    end

The PounceClient type exposes the following members.

Constructors
  NameDescription
Public methodPounceClient
Default Constructor

Pounce server updates on a 30 second cron-job and returns a list of Furres Currently on-line

Public methodPounceClient(String, String)
Set up the default Pounce Client and Friends List and Dream List

Pounce server updates on a 30 second cron-job and returns a list of Furres Currently on-line

Top
Properties
  NameDescription
Public propertyFurreList
Public propertyNumberOfDreamsOnMainMaps
(Inherited from PounceConnection.)
Public propertyOnlineList
File path to List of furres to check online status
Public propertyRawResponse
When a response from the server is received this property will contain the raw HTTP string.
(Inherited from PounceConnection.)
Top
Methods
  NameDescription
Public methodAddFriend
Adds a friend to a list of friends. Throws a Exception on non alphanumeric string.
(Inherited from PounceConnection.)
Public methodCheckFriendName
Checks a friend's name to make sure it is a valid alpha numeric (a-z0-9).

Furcadia short-name format is lowercase alpha-numeric strings

(Inherited from PounceConnection.)
Public methodCheckFriendNames
Iterates through friend's names to make sure they are valid alpha numeric (a-z0-9).
(Inherited from PounceConnection.)
Public methodClearFriends
Removes everyone from the friends list.
(Inherited from PounceConnection.)
Public methodConnect
Connects to the on-line check server and sends a on-line check request
(Inherited from PounceConnection.)
Public methodConnectAsync
Connects asynchronously to the on-line check server and sends a request without affecting the executing thread.
(Inherited from PounceConnection.)
Public methodDispose
Implement IDisposable and Dispose of PounceTimer
Protected methodDispose(Boolean)
Releases the unmanaged resources used by the PounceClient 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 methodRemoveFriend
Removes specified name from the list
(Inherited from PounceConnection.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Events
  NameDescription
Public eventResponse
Called when a on-line check request sends a response. First argument is a list of players on-line.
(Inherited from PounceConnection.)
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