T_Furcadia_Net_Pounce_PounceClient - StarShip-Avalon-Projects/FurcadiaFramework GitHub Wiki

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

System.Object
  Furcadia.Net.Pounce.PounceConnection
    Furcadia.Net.Pounce.PounceClient
Namespace: Furcadia.Net.Pounce
Assembly: FurcadiaLib (in FurcadiaLib.dll) Version: 2.19.PreAlpha 43

Syntax

C#

public class PounceClient : PounceConnection, 
	IDisposable

VB

Public Class PounceClient
	Inherits PounceConnection
	Implements IDisposable

VB Usage

Dim instance As PounceClient

C++

public ref class PounceClient : public PounceConnection, 
	IDisposable

F#

type PounceClient =  
    class
        inherit PounceConnection
        interface IDisposable
    end

The PounceClient type exposes the following members.

Constructors

 

Name Description
Public method PounceClient() Default Constructor Pounce server updates on a 30 second cron-job and returns a list of Furres Currently on-line
Public method PounceClient(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
  Back to Top

Properties

 

Name Description
Public property FurreList
Public property NumberOfDreamsOnMainMaps

(Inherited from PounceConnection.)

Public property OnlineList File path to List of furres to check online status
Public property RawResponse When a response from the server is received this property will contain the raw HTTP string. (Inherited from PounceConnection.)
  Back to Top

Methods

 

Name Description
Public method AddFriend Adds a friend to a list of friends. Throws a Exception on non alphanumeric string. (Inherited from PounceConnection.)
Public method CheckFriendName 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 method CheckFriendNames Iterates through friend's names to make sure they are valid alpha numeric (a-z0-9). (Inherited from PounceConnection.)
Public method ClearFriends Removes everyone from the friends list. (Inherited from PounceConnection.)
Public method Connect Connects to the on-line check server and sends a on-line check request (Inherited from PounceConnection.)
Public method ConnectAsync Connects asynchronously to the on-line check server and sends a request without affecting the executing thread. (Inherited from PounceConnection.)
Public method Dispose() Implement IDisposable and Dispose of PounceTimer
Protected method Dispose(Boolean) Releases the unmanaged resources used by the PounceClient 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 RemoveFriend Removes specified name from the list (Inherited from PounceConnection.)
Public method ToString Returns a string that represents the current object. (Inherited from Object.)
  Back to Top

Events

 

Name Description
Public event Response Called when a on-line check request sends a response. First argument is a list of players on-line. (Inherited from PounceConnection.)
  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.Pounce Namespace

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