Cassini Configuration API Documentation

Metabase Members

Metabase overview

Public Static (Shared) Fields

cassiniConfirationAppID For internal use only.

Public Static (Shared) Properties

ConfigFileFolder Returns path to the folder containing metabase file.
ConfigFileLocation Returns full path to the metabase file.
ConfigFileName Returns metabase file name.

Public Static (Shared) Methods

FindFreeEphemeralPort Finds a TCP port that is not in use on the system.
IsPortFree Returs true if a given TCP port is not bound.
Load Loads metabase data and returns metabase if metabase file is present. Will return a valid metabase ofbject with empty Applications collection if metabase file does not exist.
RegisterApplicationOverloaded. Registers an application and writes changes to the metabase file.
UnregisterApplicationOverloaded. Unregisters an application and saves the changes to the metabase file.

Public Static (Shared) Events

MeatabaseFileUpdated This event is triggerred by any change made to the metabase file.

Public Instance Constructors

Metabase Constructor Do not use this constructor - it's for deserialization only. User static Load() method to instantiate Metabase object.

Public Instance Properties

Applications Collection of all registered applications
Item Returns application assigned to a given port. Returns null if there is no application on the port.

Public Instance Methods

CanUsePort Returns true if given TCP port is not bound and is not assined to any Cassini application.
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
FindApplication Finds an application with a given application ID.
FindApplicationIndex Returns index of the application in the Applications array.
FindFreeTcpPort Retuns free TCP port that is also giaranteed to not be used by non-running Cassini applications.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
HasApplication Returns true if there is an application assigned to the port.
RegisterApplicationOverloaded. Adds application to the Applications collection. Does not auto-save metabase file.
Save Saves metabase data to the file.
ToString (inherited from Object) Returns a String that represents the current Object.
UnregisterApplicationOverloaded. Unregisters an application. Will save metabase file if autoSave parameter is set to true.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.

See Also

Metabase Class | CassiniConfiguration Namespace