WaveServer MembersNFX Class Library

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

The WaveServer type exposes the following members.
Constructors

  NameDescription
Public methodWaveServer 
Initializes a new instance of the WaveServer class
Public methodWaveServer(String)
Initializes a new instance of the WaveServer class
Back to Top
Methods

  NameDescription
Protected method____ObtainPrivateServiceStatusLockObject
WARNING: Developers never call this method!!! It is used by advanced derived implementations that need to synchronize status updates. We do not want to make statuslock protected as it is almost never needed, hence this accessor
(Inherited from Service.)
Protected method__setComponentDirector (Inherited from ApplicationComponent.)
Protected methodAbortStart
Allows to abort unsuccessful DoStart() overridden implementation. This method must be called from within DoStart()
(Inherited from Service.)
Public methodAcceptManagerVisit
Accepts a visit of a manager entity - this call is useful for periodic updates of service status, i.e. when service does not have a thread of its own it can be periodically managed by some other service through this method. The default implementation of DoAcceptManagerVisit(object, DateTime) does nothing
(Inherited from Service.)
Protected methodAfterListenerStart
Override to set listener options such as TimeoutManager.MinSendBytesPerSecond after listener.Start()
Protected methodBeforeListenerStart
Override to set listener options such as TimeoutManager.MinSendBytesPerSecond before listener.Start()
Public methodCheckForCompleteStop
Non-blocking call that returns true when the service instance has completely stopped after SignalStop()
(Inherited from Service.)
Protected methodCheckServiceActive
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.)
Protected methodCheckServiceActiveOrStarting
Checks for service activity and throws exception if service is not in ControlStatus.Active state
(Inherited from Service.)
Protected methodCheckServiceInactive
Checks for service inactivity and throws exception if service is running (started, starting or stopping)
(Inherited from Service.)
Public methodConfigure
Configures service from configuration node (and possibly it's sub-nodes)
(Inherited from Service.)
Protected methodDestructor (Inherited from Service.)
Public methodDispose
Deterministically disposes object. DO NOT OVERRIDE this method, override Destructor() instead
(Inherited from DisposableObject.)
Protected methodDoAcceptManagerVisit
Accepts a visit from external manager. Base implementation does nothing. Override in services that need external management calls to update their state periodically, i.e. when they don't have a thread on their own
(Inherited from Service.)
Protected methodDoCheckForCompleteStop
Provides implementation for checking whether the service has completely stopped
(Inherited from Service.)
Protected methodDoConfigure (Overrides Service DoConfigure(IConfigSectionNode).)
Protected methodDoSignalStop (Overrides Service DoSignalStop .)
Protected methodDoStart (Overrides Service DoStart .)
Protected methodDoWaitForCompleteStop (Overrides Service DoWaitForCompleteStop .)
Public methodEnsureObjectNotDisposed
Checks to see whether object dispose started or has already been disposed and throws an exception if Dispose() was called
(Inherited from DisposableObject.)
Public methodOnlineEquals
Determines whether the specified object is equal to the current object.
(Inherited from OnlineObject.)
Public methodExternalGetParameter
Gets external parameter value returning true if parameter was found
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public methodExternalParametersForGroups
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public methodExternalSetParameter
Sets external parameter value returning true if parameter was found and set
(Inherited from ServiceWithInstrumentationBase TDirector .)
Protected methodFinalize (Inherited from DisposableObject.)
Public methodOnlineGetHashCode
Serves as the default hash function.
(Inherited from OnlineObject.)
Public methodOnlineGetType
Gets the OnlineType of the current instance.
(Inherited from OnlineObject.)
Public methodHandleException
Handles processing exception by calling ErrorFilter.HandleException(work, error). All parameters except ERROR can be null - which indicates error that happened during WorkContext dispose
Public methodLocalizedTimeToUniversalTime
Converts localized time to UTC time as of TimeLocation property
(Inherited from Service.)
Public methodLog
Facilitates server logging
Protected methodMakeContext
Factory method that makes new WorkContext instances. Override to make a WorkContext-derivative
Protected methodOnlineMemberwiseClone
Creates a shallow copy of the current OnlineObject.
(Inherited from OnlineObject.)
Public methodSignalStop
Non-blocking call that initiates the stopping of the service
(Inherited from Service.)
Public methodStart
Blocking call that starts the service instance
(Inherited from Service.)
Protected methodStartByApplication
Blocking call that starts the service instance
(Inherited from Service.)
Public methodOnlineToString
Returns a string that represents the current object.
(Inherited from OnlineObject.)
Public methodUniversalTimeToLocalizedTime
Converts universal time to local time as of TimeLocation property
(Inherited from Service.)
Public methodWaitForCompleteStop
Blocks execution of current thread until this service has completely stopped
(Inherited from Service.)
Back to Top
Extension Methods

  NameDescription
Public Extension MethodAsBool (Defined by ObjectValueConversion.)
Public Extension MethodAsByte (Defined by ObjectValueConversion.)
Public Extension MethodAsChar (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDateTime(DateTime, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDID(GDID, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGDIDSymbol(GDIDSymbol, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsInt (Defined by ObjectValueConversion.)
Public Extension MethodAsJSONConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLaconicConfig (Defined by ObjectValueConversion.)
Public Extension MethodAsLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNonNullOrEmptyString (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableBool (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableChar (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDateTime (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDecimal (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableDouble (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableEnum TEnum  (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableFloat (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGDIDSymbol (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableGUID (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableLong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableShort (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableTimeSpan (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableULong (Defined by ObjectValueConversion.)
Public Extension MethodAsNullableUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsSByte (Defined by ObjectValueConversion.)
Public Extension MethodAsShort (Defined by ObjectValueConversion.)
Public Extension MethodAsString (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsTimeSpan(TimeSpan, ConvertErrorHandling)Overloaded. (Defined by ObjectValueConversion.)
Public Extension MethodAsUInt (Defined by ObjectValueConversion.)
Public Extension MethodAsULong (Defined by ObjectValueConversion.)
Public Extension MethodAsUri (Defined by ObjectValueConversion.)
Public Extension MethodAsUShort (Defined by ObjectValueConversion.)
Public Extension MethodAsXMLConfig (Defined by ObjectValueConversion.)
Public Extension MethodToErlObject Overloaded.
Try to convert .NET native object type to corresponding Erlang term. Throw exception if conversion is not possible
(Defined by ErlObject.)
Public Extension MethodToErlObject(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.)
Public Extension MethodToJSON(JSONWritingOptions)Overloaded.
Serializes object into JSON string
(Defined by JSONExtensions.)
Public Extension MethodToJSON(TextWriter, JSONWritingOptions)Overloaded.
Serializes object into JSON format using provided TextWriter
(Defined by JSONExtensions.)
Public Extension MethodToJSON(Stream, JSONWritingOptions, Encoding)Overloaded.
Serializes object into JSON format using provided stream and optional encoding
(Defined by JSONExtensions.)
Back to Top
Fields

  NameDescription
Public fieldStatic memberACCEPT_THREAD_GRANULARITY_MS
Public fieldStatic memberCONFIG_DEFAULT_ERROR_HANDLER_SECTION
Public fieldStatic memberCONFIG_DISPATCHER_SECTION
Public fieldStatic memberCONFIG_GATE_SECTION
Public fieldStatic memberCONFIG_PREFIX_SECTION
Public fieldStatic memberCONFIG_SERVER_SECTION
Public fieldStatic memberDEFAULT_CLIENT_VARS_COOKIE_NAME
Public fieldStatic memberDEFAULT_KERNEL_HTTP_QUEUE_LIMIT
Public fieldStatic memberDEFAULT_PARALLEL_ACCEPTS
Public fieldStatic memberDEFAULT_PARALLEL_WORKS
Public fieldStatic memberINSTRUMENTATION_DUMP_PERIOD_MS
Protected fieldm_InstrumentationEnabled
Protected fieldm_stat_FilterHandleException
Protected fieldm_stat_GeoLookup
Protected fieldm_stat_GeoLookupHit
Protected fieldm_stat_PortalRequest
Protected fieldm_stat_ServerAcceptSemaphoreCount
Protected fieldm_stat_ServerGateDenial
Protected fieldm_stat_ServerHandleException
Protected fieldm_stat_ServerRequest
Protected fieldm_stat_ServerWorkSemaphoreCount
Protected fieldm_stat_SessionEnd
Protected fieldm_stat_SessionExisting
Protected fieldm_stat_SessionInvalidID
Protected fieldm_stat_SessionNew
Protected fieldm_stat_WorkContextAborted
Protected fieldm_stat_WorkContextBufferedResponse
Protected fieldm_stat_WorkContextBufferedResponseBytes
Protected fieldm_stat_WorkContextCtor
Protected fieldm_stat_WorkContextDctor
Protected fieldm_stat_WorkContextHandled
Protected fieldm_stat_WorkContextNeedsSession
Protected fieldm_stat_WorkContextNoDefaultClose
Protected fieldm_stat_WorkContextWorkSemaphoreRelease
Protected fieldm_stat_WorkContextWrittenResponse
Protected fieldm_WorkSemaphore
Public fieldStatic memberMAX_KERNEL_HTTP_QUEUE_LIMIT
Public fieldStatic memberMAX_PARALLEL_ACCEPTS
Public fieldStatic memberMAX_PARALLEL_WORKS
Public fieldStatic memberMIN_KERNEL_HTTP_QUEUE_LIMIT
Public fieldStatic memberMIN_PARALLEL_ACCEPTS
Public fieldStatic memberMIN_PARALLEL_WORKS
Public fieldStatic members_Servers
Back to Top
Properties

  NameDescription
Public propertyApplicationDontAutoStartService
Checks whether the class is decorated with ApplicationDontAutoStartServiceAttribute
(Inherited from Service.)
Public propertyClientVarsCookieName
Provides the name of cookie where server keeps client vars
Public propertyComponentCommonName (Overrides ApplicationComponent ComponentCommonName.)
Public propertyComponentDirector (Inherited from Service TDirector .)
Public propertyComponentSID
Returns process/instance unique app component system id
(Inherited from ApplicationComponent.)
Public propertyComponentStartTime
Returns local computer time of component start (not from application container time)
(Inherited from ApplicationComponent.)
Public propertyDispatcher
Gets/sets work dispatcher
Public propertyDisposed
Indicates whether this object was already disposed - the Dispose() has finished
(Inherited from DisposableObject.)
Public propertyDisposeStarted
Indicates whether this object Dispose() has been called and dispose started but not finished yet
(Inherited from DisposableObject.)
Public propertyEnvironmentName
Provides the name of environment, i.e. DEV,PROD, TEST i.e. some handlers may depend on environment name to serve DEV vs PROD java script files etc.
Public propertyExternalParameters
Returns named parameters that can be used to control this component
(Inherited from ServiceWithInstrumentationBase TDirector .)
Public propertyGate
Gets/sets network gate
Public propertyGateCallerRealIpAddressHeader
Public propertyIgnoreClientWriteErrors
When true does not throw exceptions on client channel write
Public propertyInstrumentationEnabled
When true, emits instrumentation messages
(Overrides ServiceWithInstrumentationBase TDirector  InstrumentationEnabled.)
Public propertyKernelHttpQueueLimit
Establishes HTTP.sys kernel queue limit
Public propertyLocalizedTime
Returns current time localized per TimeLocation
(Inherited from Service.)
Public propertyLogHandleExceptionErrors
When true writes errors that get thrown in server cathc-all HandleException methods
Public propertyLogMatches
Returns matches used by the server's default error handler to determine whether exception details should be logged
Public propertyName
Provides textual name for the service
(Inherited from Service.)
Public propertyParallelAccepts
Specifies how many requests can get accepted from kernel queue in parallel
Public propertyParallelWorks
Specifies how many instances of WorkContext(or derivatives) can be processed at the same time
Public propertyPrefixes
Returns HttpListener prefixes such as "http://+:8080/"
Public propertyRunning
Returns true when service is active or about to become active. Check in service implementation loops/threads/tasks
(Inherited from Service.)
Public propertyStatic memberServers
Returns the global registry of all server instances that are active in this process
Public propertyShowDumpMatches
Returns matches used by the server's default error handler to determine whether exception details should be shown
Public propertyStatus
Current service status
(Inherited from Service.)
Public propertyTimeLocation
Returns time location of this LocalizedTimeProvider implementation
(Inherited from Service.)
Back to Top
See Also