DOFObjectbeginSession Method OpenDOF Object Access Library
Overload List
  NameDescription
Public methodbeginSession(DOFInterface, DOFInterfaceID)
Used by a Requestor to begin a session with an indefinite duration (equivalent to specifying a timeout of DOF.TIMEOUT_NEVER ). A session is an object provided exclusively for a requestor. No other requestor is allowed to access the session object. Use Session.waitSession(int) to ensure that the session object is available. Use DOFSystem.waitProvider(DOFInterfaceID, int) to make sure there's a route to the provider. The session ends when its timeout expires or when the session operation is cancelled. Attempting to open a session on a "session object" (an object returned by Session.waitSession(int) ) is not supported.

NOTE: It is not necessary to call

Copy
destroy()
on the session object. The library will destroy the session object when the operation completes or is cancelled.

NOTE: Interest is required (through DOFSystem.beginInterest(DOFObjectID, DOFInterestLevel) for this operation in order to determine the primary provider. If no interest is specified, then this operation will result in a DOFErrorException.TIMEOUT exception.

NOTE: If the primary provider changes during the lifetime of this operation, and the Control response level includes exceptions, then see SessionOperationListener.complete(DOFOperation, DOFException) .

Public methodbeginSession(DOFInterface, DOFInterfaceID, DOFObjectSessionOperationListener)
Used by a Requestor to begin a session with an indefinite duration (equivalent to specifying a timeout of DOF.TIMEOUT_NEVER ). A session is an object provided exclusively for a requestor. No other requestor is allowed to access the session object. Use Session.waitSession(int) to ensure that the session object is available. Use DOFSystem.waitProvider(DOFInterfaceID, int) to make sure there's a route to the provider. The session ends when its timeout expires or when the session operation is cancelled. Attempting to open a session on a "session object" (an object returned by Session.waitSession(int) ) is not supported.

NOTE: It is not necessary to call

Copy
destroy()
on the session object. The library will destroy the session object when the operation completes or is cancelled.

NOTE: Interest is required (through DOFSystem.beginInterest(DOFObjectID, DOFInterestLevel) for this operation in order to determine the primary provider. If no interest is specified, then this operation will result in a DOFErrorException.TIMEOUT exception.

NOTE: If the primary provider changes during the lifetime of this operation, and the Control response level includes exceptions, then see SessionOperationListener.complete(DOFOperation, DOFException) .

Public methodbeginSession(DOFInterface, DOFInterfaceID, Int32, DOFObjectSessionOperationListener)
Used by a Requestor to begin a session.
Public methodbeginSession(DOFInterface, DOFInterfaceID, Int32, DOFObjectSessionOperationListener, Object)
Used by a Requestor to begin a session.
Public methodbeginSession(DOFInterface, DOFInterfaceID, DOFOperationControl, Int32, DOFObjectSessionOperationListener, Object)
Used by a Requestor to begin a session.
Top
See Also

Reference

DOFObject Class
org.opendof.core.oal Namespace