.NET Based OPC UA Client/Server SDK
3.0.3.458
|
A generic session manager object for a server. More...
Inherits IDisposable, and UnifiedAutomation.UaBase.IMapperContext.
Public Member Functions | |
Session (RequestContext context, ICertificate serverCertificate, NodeId authenticationToken, byte[] serverNonce, string sessionName, ApplicationDescription clientDescription, string endpointUrl, ICertificate clientCertificate, double sessionTimeout, uint maxResponseMessageSize, double maxRequestAge, uint maxBrowseContinuationPoints, uint maxHistoryContinuationPoints, uint maxQueryContinuationPoints) | |
Initializes the session. More... | |
void | Dispose () |
Frees any unmanaged resources. More... | |
bool | CheckIfExpired (uint minSessionTimeout) |
Check if the session timeout has elapsed since the last communication from the client. More... | |
virtual void | ValidateRequest (RequestHeader requestHeader, ServiceType requestType) |
Validates the request. More... | |
void | RequestStarted (RequestContext context) |
Saves a request that has started. More... | |
void | RequestComplete (RequestContext context) |
Removes a request once it completes. More... | |
List< RequestContext > | CancelRequests (uint requestHandle) |
Cancels the requests. More... | |
virtual bool | IsSecureChannelValid (string secureChannelId) |
Checks if the secure channel is currently valid. More... | |
bool | UpdateLocaleIds (StringCollection localeIds) |
Updates the requested locale ids. More... | |
void | ValidateBeforeActivate (RequestContext context, SignatureData clientSignature, List< SignedSoftwareCertificate > clientSoftwareCertificates, ExtensionObject userIdentityToken, SignatureData userTokenSignature, StringCollection localeIds, byte[] serverNonce, out UserIdentityToken identityToken, out UserTokenPolicy userTokenPolicy) |
Activates the session and binds it to the current secure channel. More... | |
bool | Activate (RequestContext context, List< SignedSoftwareCertificate > clientSoftwareCertificates, UserIdentityToken identityToken, UserIdentity identity, UserIdentity effectiveIdentity, StringCollection localeIds, byte[] serverNonce) |
Activates the session and binds it to the current secure channel. More... | |
void | Close () |
Closes a session and removes itself from the address space. More... | |
void | SaveContinuationPoint (ContinuationPoint continuationPoint) |
Saves a continuation point for a session. More... | |
ContinuationPoint | RestoreContinuationPoint (byte[] continuationPoint) |
Restores a continuation point for a session. More... | |
void | SaveQueryContinuationPoint (QueryContinuationPoint continuationPoint) |
Saves a continuation point for a session. More... | |
QueryContinuationPoint | RestoreQueryContinuationPoint (byte[] continuationPoint) |
Restores a continuation point for a session. More... | |
void | SaveHistoryContinuationPoint (HistoryContinuationPoint continuationPoint) |
Saves a continuation point used for historical reads. More... | |
HistoryContinuationPoint | RestoreHistoryContinuationPoint (byte[] continuationPoint) |
Restores a previously saves history continuation point. More... | |
RegisteredNode | RegisterNode (NodeId nodeId) |
Registers the node. More... | |
RegisteredNode | FindRegisteredNode (NodeId nodeId) |
Finds the registered node. More... | |
void | UnregisterNode (NodeId nodeId) |
Unregisters the node. More... | |
Protected Member Functions | |
virtual void | Dispose (bool disposing) |
An overrideable version of the Dispose. More... | |
Properties | |
ServerManager | Server [get] |
Gets the server. More... | |
NodeId | Id [get] |
The identifier assigned to the session when it was created. More... | |
uint | SessionScopeId [get, set] |
The ScopeId used for Session and Subscription diagnostics nodes. More... | |
UserIdentity | Identity [get] |
The user identity provided by the client. More... | |
UserIdentity | EffectiveIdentity [get] |
The application defined mapping for user identity provided by the client. More... | |
UserIdentityToken | IdentityToken [get] |
The user identity token provided by the client. More... | |
object | DiagnosticsLock [get] |
A lock which must be acquired before accessing the diagnostics. More... | |
SessionDiagnosticsObjectModel | SessionDiagnostics [get] |
The diagnostics associated with the session. More... | |
NodeId | SubscriptionDiagnosticsArrayNodeId [get] |
Gets the subscription diagnostics array node id. More... | |
string | SessionName [get] |
Gets the SessionName. More... | |
ICertificate | ClientCertificate [get] |
The application instance certificate associated with the client. More... | |
string[] | PreferredLocales [get] |
The locales requested when the session was created. More... | |
bool | Activated [get] |
Whether the session has been activated. More... | |
A generic session manager object for a server.
|
inline |
Initializes the session.
|
inline |
Activates the session and binds it to the current secure channel.
|
inline |
Cancels the requests.
requestHandle | The request handle. |
|
inline |
Check if the session timeout has elapsed since the last communication from the client.
minSessionTimeout | The timeout to use if the session has not been activated. |
|
inline |
Closes a session and removes itself from the address space.
|
inline |
Frees any unmanaged resources.
|
inlineprotectedvirtual |
An overrideable version of the Dispose.
|
inline |
Finds the registered node.
nodeId | The node id. |
|
inlinevirtual |
Checks if the secure channel is currently valid.
|
inline |
Registers the node.
nodeId | The node id. |
|
inline |
Removes a request once it completes.
context | The request context. |
|
inline |
Saves a request that has started.
context | The request context. |
|
inline |
Restores a continuation point for a session.
The caller is responsible for disposing the continuation point returned.
|
inline |
Restores a previously saves history continuation point.
continuationPoint | The identifier for the continuation point. |
|
inline |
Restores a continuation point for a session.
The caller is responsible for disposing the continuation point returned.
|
inline |
Saves a continuation point for a session.
If the session has too many continuation points the oldest one is dropped.
|
inline |
Saves a continuation point used for historical reads.
continuationPoint | The continuation point. |
If the continuationPoint implements IDisposable it will be disposed when the Session is closed or discarded.
|
inline |
Saves a continuation point for a session.
If the session has too many continuation points the oldest one is dropped.
|
inline |
Unregisters the node.
nodeId | The node id. |
|
inline |
Updates the requested locale ids.
|
inline |
Activates the session and binds it to the current secure channel.
|
inlinevirtual |
Validates the request.
|
get |
Whether the session has been activated.
|
get |
The application instance certificate associated with the client.
|
get |
A lock which must be acquired before accessing the diagnostics.
|
get |
The application defined mapping for user identity provided by the client.
|
get |
The identifier assigned to the session when it was created.
|
get |
The user identity provided by the client.
|
get |
The user identity token provided by the client.
|
get |
The locales requested when the session was created.
|
get |
Gets the server.
|
get |
The diagnostics associated with the session.
|
get |
Gets the SessionName.
|
getset |
The ScopeId used for Session and Subscription diagnostics nodes.
|
get |
Gets the subscription diagnostics array node id.