ServiceBaseApplication Members

NFX Class Library

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

The ServiceBaseApplication type exposes the following members.

Constructors

	Name	Description
	ServiceBaseApplication( String , ConfigSectionNode)	Takes optional application args[] and root configuration. The args are parsed into CommandArgsConfiguration.
	ServiceBaseApplication(String, Configuration, ConfigSectionNode)	Takes optional command-line configuration args and root configuration. If configuration is null then application is configured from a file co-located with entry-point assembly and called the same name as assembly with '.config' extension, unless args are specified and "/config file" switch is used in which case 'file' has to be locatable and readable.

Methods

	Name	Description
	BeforeDataStoreStart	Override to prep data store implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeEventTimerStart	Override to prep event timer implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeGlueStart	Override to prep glue implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeInstrumentationStart	Override to prep instr implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeLogStart	Override to prep log implementation i.e. inject log destinations programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeObjectStoreStart	Override to prep object store implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeSecurityManagerStart	Override to prep security manager implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeThrottlingStart	Override to prep throttling implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	BeforeTimeSourceStart	Override to prep time source implementation i.e. inject something programmaticaly (Inherited from CommonApplicationLogic.)
	CleanupApplication	(Inherited from CommonApplicationLogic.)
	Destroy	Destroys application effectively finalizing all services
	Destructor	(Overrides CommonApplicationLogic Destructor .)
	Dispose	Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead (Inherited from DisposableObject.)
	DoCleanupApplication	(Inherited from CommonApplicationLogic.)
	DoInitApplication	(Inherited from CommonApplicationLogic.)
	EnsureObjectNotDisposed	Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called (Inherited from DisposableObject.)
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object.)
	Finalize	(Inherited from DisposableObject.)
	GetConfiguration
	GetDefaultConfigFileName	Tries to find a configuration file name looping through various supported estensions (Inherited from CommonApplicationLogic.)
	GetHashCode	Serves as the default hash function. (Inherited from Object.)
	GetStarters	(Inherited from CommonApplicationLogic.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	InitApplication	(Inherited from CommonApplicationLogic.)
	LocalizedTimeToUniversalTime	Converts localized time to UTC time as of TimeLocation property (Inherited from CommonApplicationLogic.)
	MakeNewSessionInstance	Makes BaseSession instance (Inherited from CommonApplicationLogic.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	NotifyAllConfigSettingsAboutChange	Forces notification of all registered IConfigSettings-implementers about configuration change (Inherited from CommonApplicationLogic.)
	NotifyAllConfigSettingsAboutChange(IConfigSectionNode)	Forces notification of all registered IConfigSettings-implementers about configuration change (Inherited from CommonApplicationLogic.)
	PreloadAssemblies	RESERVED for future use. Loads assemblies specified in 'preload-assemblies' section from disk optionally checking the 'enabled' flag. This method is called on application startup by the framework (Inherited from CommonApplicationLogic.)
	RegisterAppFinishNotifiable	Registers an instance of IApplicationFinishNotifiable with application container to receive a call when underlying application instance will finish its lifecycle (Inherited from CommonApplicationLogic.)
	RegisterConfigSettings	Registers an instance of IConfigSettings with application container to receive a call when underlying app configuration changes (Inherited from CommonApplicationLogic.)
	Stop	Initiates the stop of the application by setting its Stopping to true and Active to false so dependent services may start to terminate (Inherited from CommonApplicationLogic.)
	ToString	Returns a string that represents the current object. (Inherited from Object.)
	UniversalTimeToLocalizedTime	Converts universal time to local time as of TimeLocation property (Inherited from CommonApplicationLogic.)
	UnregisterAppFinishNotifiable	Removes the registration of IConfigSettings from application container (Inherited from CommonApplicationLogic.)
	UnregisterConfigSettings	Removes the registration of IConfigSettings from application container (Inherited from CommonApplicationLogic.)
	WriteLog	(Inherited from CommonApplicationLogic.)

Extension Methods

	Name	Description
	AsBool	(Defined by ObjectValueConversion.)
	AsByte	(Defined by ObjectValueConversion.)
	AsChar	(Defined by ObjectValueConversion.)
	AsDateTime	Overloaded. (Defined by ObjectValueConversion.)
	AsDateTime(DateTime, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsDecimal	(Defined by ObjectValueConversion.)
	AsDouble	(Defined by ObjectValueConversion.)
	AsEnum TEnum	(Defined by ObjectValueConversion.)
	AsFloat	(Defined by ObjectValueConversion.)
	AsGDID	Overloaded. (Defined by ObjectValueConversion.)
	AsGDID(GDID, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol	Overloaded. (Defined by ObjectValueConversion.)
	AsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsGUID	(Defined by ObjectValueConversion.)
	AsInt	(Defined by ObjectValueConversion.)
	AsJSONConfig	(Defined by ObjectValueConversion.)
	AsLaconicConfig	(Defined by ObjectValueConversion.)
	AsLong	(Defined by ObjectValueConversion.)
	AsNonNullOrEmptyString	(Defined by ObjectValueConversion.)
	AsNullableBool	(Defined by ObjectValueConversion.)
	AsNullableByte	(Defined by ObjectValueConversion.)
	AsNullableChar	(Defined by ObjectValueConversion.)
	AsNullableDateTime	(Defined by ObjectValueConversion.)
	AsNullableDecimal	(Defined by ObjectValueConversion.)
	AsNullableDouble	(Defined by ObjectValueConversion.)
	AsNullableEnum TEnum	(Defined by ObjectValueConversion.)
	AsNullableFloat	(Defined by ObjectValueConversion.)
	AsNullableGDID	(Defined by ObjectValueConversion.)
	AsNullableGDIDSymbol	(Defined by ObjectValueConversion.)
	AsNullableGUID	(Defined by ObjectValueConversion.)
	AsNullableInt	(Defined by ObjectValueConversion.)
	AsNullableLong	(Defined by ObjectValueConversion.)
	AsNullableSByte	(Defined by ObjectValueConversion.)
	AsNullableShort	(Defined by ObjectValueConversion.)
	AsNullableTimeSpan	(Defined by ObjectValueConversion.)
	AsNullableUInt	(Defined by ObjectValueConversion.)
	AsNullableULong	(Defined by ObjectValueConversion.)
	AsNullableUShort	(Defined by ObjectValueConversion.)
	AsSByte	(Defined by ObjectValueConversion.)
	AsShort	(Defined by ObjectValueConversion.)
	AsString	(Defined by ObjectValueConversion.)
	AsTimeSpan	Overloaded. (Defined by ObjectValueConversion.)
	AsTimeSpan(TimeSpan, ConvertErrorHandling)	Overloaded. (Defined by ObjectValueConversion.)
	AsUInt	(Defined by ObjectValueConversion.)
	AsULong	(Defined by ObjectValueConversion.)
	AsUri	(Defined by ObjectValueConversion.)
	AsUShort	(Defined by ObjectValueConversion.)
	AsXMLConfig	(Defined by ObjectValueConversion.)
	ToErlObject	Overloaded. Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToErlObject(ErlTypeOrder, Boolean)	Overloaded. Try to convert .NET native object type to corresponding Erlang term of given type. Throw exception if conversion is not possible (Defined by ErlObject.)
	ToJSON(JSONWritingOptions)	Overloaded. Serializes object into JSON string (Defined by JSONExtensions.)
	ToJSON(TextWriter, JSONWritingOptions)	Overloaded. Serializes object into JSON format using provided TextWriter (Defined by JSONExtensions.)
	ToJSON(Stream, JSONWritingOptions, Encoding)	Overloaded. Serializes object into JSON format using provided stream and optional encoding (Defined by JSONExtensions.)

Fields

	Name	Description
	m_CommandArgs
	m_ConfigRoot	(Inherited from CommonApplicationLogic.)
	m_ConfigSettings	(Inherited from CommonApplicationLogic.)
	m_DataStore	(Inherited from CommonApplicationLogic.)
	m_EventTimer	(Inherited from CommonApplicationLogic.)
	m_FinishNotifiables	(Inherited from CommonApplicationLogic.)
	m_Glue	(Inherited from CommonApplicationLogic.)
	m_Instrumentation	(Inherited from CommonApplicationLogic.)
	m_Log	(Inherited from CommonApplicationLogic.)
	m_ObjectStore	(Inherited from CommonApplicationLogic.)
	m_SecurityManager	(Inherited from CommonApplicationLogic.)
	m_Throttling	(Inherited from CommonApplicationLogic.)
	m_TimeSource	(Inherited from CommonApplicationLogic.)
	s_Instance

Properties

	Name	Description
	Active	Returns true when application instance is active and working. This property returns false as soon as application finalization starts on shutdown Use to exit long-running loops and such (Inherited from CommonApplicationLogic.)
	AppName	Returns application name
	CmdArgs	References command line arguments configuration, so one can use it as: View Colorized Copy to Clipboard Print if (Servicepplication.CmdArgs["DeleteFiles"].Exists) { // this will run if process was invoked like so: process.exe /deleteFiles } if (Servicepplication.CmdArgs["DeleteFiles"].Exists) { // this will run if process was invoked like so: process.exe /deleteFiles }
	CommandArgs	References command line arguments configuration, so one can use it as: View Colorized Copy to Clipboard Print if (ServiceApplication.Instance.CommandArgs["DeleteFiles"].Exists) { // this will run if process was invoked like so: process.exe /deleteFiles } if (ServiceApplication.Instance.CommandArgs["DeleteFiles"].Exists) { // this will run if process was invoked like so: process.exe /deleteFiles }
	ConfigRoot	Provides access to configuration root for the whole application (Inherited from CommonApplicationLogic.)
	ConfRoot	Provides access to configuration root for the whole application
	ContextAvailable	Indicates whether application context was allocated
	Data	References application data store
	DataStore	References application data store (Inherited from CommonApplicationLogic.)
	Disposed	Indicates whether this object was already disposed - the Dispose() has finished (Inherited from DisposableObject.)
	DisposeStarted	Indicates whether this object Dispose() has been called and dispose started but not finished yet (Inherited from DisposableObject.)
	EventTimer	References event timer which maintains and runs scheduled Event instances (Inherited from CommonApplicationLogic.)
	Glue	References glue that can be used to interconnect remote instances (Inherited from CommonApplicationLogic.)
	Glues	References glue that can be used to connect to remote entities
	Instance	References a singleton instance of BaseApplication
	InstanceID	Returns unique identifier of this running instance (Inherited from CommonApplicationLogic.)
	Instrumentation	References application instrumentation (Inherited from CommonApplicationLogic.)
	Instruments	References application instrumentation
	IsActive	Returns true when application instance is active and working. This property returns false as soon as application finalization starts on shutdown Use to exit long-running loops and such
	IsUnitTest	(Inherited from CommonApplicationLogic.)
	LocalizedTime	Returns current time localized per TimeLocation (Inherited from CommonApplicationLogic.)
	Log	References application logger (Inherited from CommonApplicationLogic.)
	Logger	References application logger
	Name	Returns the name of this application (Inherited from CommonApplicationLogic.)
	Objects	References application object store. Objects will survive application termination
	ObjectStore	References application object store. Objects will survive application termination (Inherited from CommonApplicationLogic.)
	Security	References security manager that performs user authentication based on passed credentials and other security-related global tasks
	SecurityManager	References security manager that performs user authentication based on passed credentials and other security-related global tasks (Inherited from CommonApplicationLogic.)
	ShutdownStarted	Returns true to indicate that Dispose() has been called and shutdown has started (Inherited from CommonApplicationLogic.)
	StartTime	Returns timestamp when application started as localized app time (Inherited from CommonApplicationLogic.)
	Stopping	Returns true to indicate that Stop() was called (Inherited from CommonApplicationLogic.)
	Throttles	References application throttling
	Throttling	References application throttling (Inherited from CommonApplicationLogic.)
	Time	References time source - an entity that supplies local and UTC times. The concrete implementation may elect to get accurate times from the network or other external precision time sources (i.e. NASA atomic clock)
	TimeLocation	Returns time location of this LocalizedTimeProvider implementation (Inherited from CommonApplicationLogic.)
	Timer	References event timer which maintains and runs scheduled Event instances
	TimeSource	References time source - an entity that supplies local and UTC times. The concrete implementation may elect to get accurate times from the network or other external precision time sources (i.e. NASA atomic clock) (Inherited from CommonApplicationLogic.)