The ApplicationAdapter type exposes the following members.

Methods

  NameDescription
Public methodaddChildScope (Inherited from AbstractScopeAdapter.)
Public methodaddListener
Register listener that will get notified about application events. Please note that return values (e.g. from [!:IApplication#appStart(IScope)]) will be ignored for listeners.
Public methodaddScheduledJob
Wrapper around ISchedulingService, adds a scheduled job to be run periodically. We store this service in the scope as it can be shared across all rooms of the applications.
Public methodaddScheduledOnceJob(DateTime, IScheduledJob)
Adds a scheduled job that's gonna be executed once on given date. Please note that the jobs are not saved if WebORB is restarted in the meantime.
Public methodaddScheduledOnceJob(Int64, IScheduledJob)
Adds a scheduled job that's gonna be executed once. Please note that the jobs are not saved if WebORB is restarted in the meantime.
Public methodappConnect
Handler method. Called every time new client connects (that is, new IConnection object is created after call from a SWF movie) to the application. You override this method to pass additional data from client to server application using
CopyC#
NetConnection.connect
method.
Public methodappDisconnect
Handler method. Called every time client disconnects from the application.
Public methodappJoin
Handler method. Called every time client join application scope.
Public methodappLeave
Handler method. Called every time client leaves application scope.
Public methodappStart
Called once on scope (that is, application or application room) start. You override [!:ApplicationAdapter#appStart(IScope)] or [!:ApplicationAdapter#roomStart(IScope)] in your application to make it act the way you want.
Public methodappStop
Handler method. Called when application is stopped.
Public methodcancelGhostConnectionsCleanup
Cancel ghost connections cleanup period
Public methodclearSharedObjects
Public methodconnect
Returns connection result for given scope and parameters. Whether the scope is room or app level scope, this method distinguishes it and acts accordingly. You override [!:ApplicationAdapter#appConnect(IConnection, Object[])] or [!:ApplicationAdapter#roomConnect(IConnection, Object[])] in your application to make it act the way you want.
(Overrides AbstractScopeAdapter..::..connect(IConnection, IScope, array<Object>[]()[][]).)
Public methodcreateChildScope (Inherited from StatefulScopeWrappingAdapter.)
Public methodcreateSharedObject
Creates a new shared object for given scope. Server-side shared objects (also known as Remote SO) are special kind of objects those variable are synchronized between clients. To get an instance of RSO at client-side, use
CopyC#
SharedObject.getRemote()
. SharedObjects can be persistent and transient. Persistent RSO are statuful, i.e. store their data between sessions. If you need to store some data on server while clients go back and forth use persistent SO (just use
CopyC#
true
), otherwise perfer usage of transient for extra performance.
Public methoddisconnect
Returns disconnection result for given scope and parameters. Whether the scope is room or app level scope, this method distinguishes it and acts accordingly.
(Overrides AbstractScopeAdapter..::..disconnect(IConnection, IScope).)
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
(Inherited from Object.)
Public methodgetAttribute(String) (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetAttribute(String, Object) (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetAttributeNames (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetAttributes (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetBroadcastStream
Get a broadcast stream by name
Public methodgetBroadcastStreamNames
Returns list of stream names broadcasted in
scope
. Broadcast stream name is somewhat different from server stream name. Server stream name is just an ID assigned by WebORB to every created stream. Broadcast stream name is the name that is being used to subscribe to the stream at client side, that is, in
CopyC#
NetStream.play
call.
Public methodgetChildScope (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetChildScopeNames (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetClients (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetClientTTL
Client time to live is max allowed connection ping return time in seconds
Public methodgetConnectionsIter (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetConnectionsSyncRoot (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetContext (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetDepth (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetGhostConnsCleanupPeriod
Return period of ghost connections cleanup task call
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodgetListeners
Return handlers that get notified about application events.
Public methodgetMaxPingRetryCount
Retrieves maximum ping retry count
Public methodgetName (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetOnDemandStream
Returns VOD stream with given name from specified scope.
Public methodgetParent (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetPath (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetResource (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetResources (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetScheduledJobNames
Retuns list of scheduled job names
Public methodgetScope (Inherited from StatefulScopeWrappingAdapter.)
Public methodgetSharedObject(IScope, String)
Returns shared object from given scope by name.
Public methodgetSharedObject(IScope, String, Boolean)
Returns shared object from given scope by name.
Public methodgetSharedObjectNames
Returns available SharedObject names as List
Public methodgetStreamLength
Returns stream length. This is a hook so do not count on this method because situation may one day. NOTE: Method added to get flv player to work.
Public methodgetStreamPlaybackSecurity
Get handlers that protect stream playback.
Public methodgetStreamPublishSecurity
Get handlers that protect stream publishing.
Public methodgetSubscriberStream
Returns subscriber stream with given name from specified scope. Subscriber stream is a stream that clients can subscribe to.
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodhandleEvent (Inherited from AbstractScopeAdapter.)
Public methodhasAttribute (Inherited from StatefulScopeWrappingAdapter.)
Public methodhasBroadcastStream
Does the scope have a broadcast stream registered with a given name
Public methodhasChildScope (Inherited from StatefulScopeWrappingAdapter.)
Public methodhasOnDemandStream
Check whether scope has VOD stream with given name or not
Public methodhasParent (Inherited from StatefulScopeWrappingAdapter.)
Public methodhasSharedObject
Checks whether there's a SO with given scope and name
Public methodjoin
Adds client to scope. Scope can be both application or room. Can be applied to both application scope and scopes of lower level. This method calls [!:ApplicationAdapter#appJoin(IClient, IScope)] or [!:ApplicationAdapter#roomJoin(IClient, IScope)] handlers respectively.
(Overrides AbstractScopeAdapter..::..join(IClient, IScope).)
Protected methodkillGhostConnections
Cleans up ghost connections
Public methodleave
Disconnects client from scope. Can be applied to both application scope and scopes of lower level. This method calls [!: ApplicationAdapter#appLeave(IClient, IScope)] or [!:ApplicationAdapter#roomLeave(IClient, IScope)] handlers respectively.
(Overrides AbstractScopeAdapter..::..leave(IClient, IScope).)
Public methodlookupConnections (Inherited from StatefulScopeWrappingAdapter.)
Public methodmeasureBandwidth()()()()
Try to measure bandwidth of current connection. This is required for some FLV player to work because they require the "onBWDone" method to be called on the connection.
Public methodmeasureBandwidth(IConnection)
Try to measure bandwidth of given connection. This is required for some FLV player to work because they require the "onBWDone" method to be called on the connection.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Public methodregisterStreamPlaybackSecurity
Add handler that protects stream playback.
Public methodregisterStreamPublishSecurity
Add handler that protects stream publishing.
Protected methodrejectClient()()()()
Reject the currently connecting client without a special error message. This method throws ClientRejectedException exception.
Protected methodrejectClient(Object)
The passed object will be available as "application" property of the information object that is returned to the caller.
Public methodremoveAttribute (Inherited from StatefulScopeWrappingAdapter.)
Public methodremoveAttributes (Inherited from StatefulScopeWrappingAdapter.)
Public methodremoveChildScope (Inherited from AbstractScopeAdapter.)
Public methodremoveListener
Unregister handler that will not get notified about application events any longer.
Public methodremoveScheduledJob
Removes scheduled job from scheduling service list
Public methodroomConnect
Handler method. Called every time new client connects (that is, new IConnection object is created after call from a SWF movie) to the application. You override this method to pass additional data from client to server application using
CopyC#
NetConnection.connect
method. See [!:ApplicationAdapter#appConnect(IConnection, Object[])] for code example.
Public methodroomDisconnect
Handler method. Called every time client disconnects from the room.
Public methodroomJoin
Handler method. Called every time client join room scope.
Public methodroomLeave
Handler method. Called every time client leaves room scope.
Public methodroomStart
Handler method. Called when room scope is started.
Public methodroomStop
Handler method. Called when room scope is stopped.
Public methodscheduleGhostConnectionsCleanup
Schedules new ghost connections cleanup using current cleanup period
Public methodserviceCall (Inherited from AbstractScopeAdapter.)
Public methodsetAttribute (Inherited from StatefulScopeWrappingAdapter.)
Public methodsetAttributes(IDictionary<(Of <<'(String, Object>)>>)) (Inherited from StatefulScopeWrappingAdapter.)
Public methodsetAttributes(IAttributeStore) (Inherited from StatefulScopeWrappingAdapter.)
Public methodsetCanCallService (Inherited from AbstractScopeAdapter.)
Public methodsetCanConnect (Inherited from AbstractScopeAdapter.)
Public methodsetCanStart (Inherited from AbstractScopeAdapter.)
Public methodsetClientTTL
Client time to live is max allowed connection ping return time in seconds
Public methodsetGhostConnsCleanupPeriod
Set new ghost connections cleanup period
Public methodsetJoin (Inherited from AbstractScopeAdapter.)
Public methodsetMaxPingRetryCount
Updates the maximum ping retry count. When pinging is on, each connection maintains its own ping retry count. This is the number of ping messages sent to a connection without a response. When the number is equal or greater than maxPingRetryCount, the connection is terminated. Default value is 3.
Public methodsetScope (Inherited from StatefulScopeWrappingAdapter.)
Public methodstart
Starts scope. Scope can be both application or room level.
(Overrides AbstractScopeAdapter..::..start(IScope).)
Public methodstop
Stops scope handling (that is, stops application if given scope is app level scope and stops room handling if given scope has lower scope level). This method calls [!:ApplicationAdapter#appStop(IScope)] or [!:ApplicationAdapter#roomStop(IScope)] handlers respectively.
(Overrides AbstractScopeAdapter..::..stop(IScope).)
Public methodToString
Returns a String that represents the current Object.
(Inherited from Object.)
Public methodunregisterStreamPlaybackSecurity
Remove handler that protects stream playback.
Public methodunregisterStreamPublishSecurity
Remove handler that protects stream publishing.

See Also