com.inductiveautomation.opcua.sessions

Interface Session

All Superinterfaces:

PublishRequestListener, SessionServiceProvider

public interface Session
extends PublishRequestListener, SessionServiceProvider

Field Summary

Fields

Modifier and Type	Field and Description
static int	SESSION_NAMESPACE

Method Summary

Modifier and Type	Method and Description
void	activate(UInt32 channelId) Activates this Session on the given channel id.
void	close(boolean deleteSubscriptions) Deactivates this Session and deletes all of its subscriptions if appropriate.
PublishRequest	dequeuePublishRequest() Polls the request queue for a PublishRequest.
void	enqueuePublishRequest(PublishRequest request) Add a PublishRequest to the request queue.
void	enqueueStatusChange(UInt32 subscriptionId, NotificationMessage message)
java.util.List<StatusCode>	getAckResultsForRequest(PublishRequest request) Gets the list of results (StatusCode) for the list of SubscriptionAcknowledgement's that was sent with the given PublishRequest.
AddressSpace	getAddressSpace()
NodeId	getAuthenticationToken() Gets the NodeId used as the authentication token in this Session.
UInt32	getChannelId()
java.util.concurrent.ScheduledExecutorService	getExecutor()
NodeId	getId() Gets the NodeId used to identify this Session.
byte[]	getLastNonce()
java.lang.String	getName() Gets the name of this Session.
Subscription	getSubscription(UInt32 subscriptionId)
java.util.List<Subscription>	getSubscriptions()
boolean	isActivated()
void	sendPublishResponse(PublishRequest request, PublishResponse response)

Methods inherited from interface com.inductiveautomation.opcua.sessions.PublishRequestListener

publishRequestReceived

Methods inherited from interface com.inductiveautomation.opcua.sessions.SessionServiceProvider

createSubscription, deleteSubscriptions, receive, transfer

Field Detail

SESSION_NAMESPACE

static final int SESSION_NAMESPACE

See Also:

Constant Field Values

Method Detail

enqueuePublishRequest

void enqueuePublishRequest(PublishRequest request)

Add a PublishRequest to the request queue.

Parameters:

request - PublishRequest to enqueue.

dequeuePublishRequest

PublishRequest dequeuePublishRequest()

Polls the request queue for a PublishRequest. Will return null if nothing is queued. Check #isPublishRequestQueued() for the availability of a PublishRequest first.

Returns:

PublishRequest that has been dequeued.

activate

void activate(UInt32 channelId)

Activates this Session on the given channel id.

Parameters:

channelId - The channelId of the channel this session is active on.

close

void close(boolean deleteSubscriptions)

Deactivates this Session and deletes all of its subscriptions if appropriate.

Parameters:

deleteSubscriptions - true or false, indicating whether or not this Session should delete its Subscription's.

getAckResultsForRequest

java.util.List<StatusCode> getAckResultsForRequest(PublishRequest request)

Gets the list of results (StatusCode) for the list of SubscriptionAcknowledgement's that was sent with the given PublishRequest.

Parameters:

request -

Returns:

getId

NodeId getId()

Gets the NodeId used to identify this Session.

Returns:

NodeId used to identify this Session.

getAuthenticationToken

NodeId getAuthenticationToken()

Gets the NodeId used as the authentication token in this Session.

Returns:

The NodeId used as the authentication token in this Session .

getName

java.lang.String getName()

Gets the name of this Session.

Returns:

The name of this Session

getChannelId

UInt32 getChannelId()

Returns:

The channel id this Session is activated on.

getExecutor

java.util.concurrent.ScheduledExecutorService getExecutor()

getAddressSpace

AddressSpace getAddressSpace()

isActivated

boolean isActivated()

getSubscription

Subscription getSubscription(UInt32 subscriptionId)

getSubscriptions

java.util.List<Subscription> getSubscriptions()

getLastNonce

byte[] getLastNonce()

sendPublishResponse

void sendPublishResponse(PublishRequest request,
                         PublishResponse response)

enqueueStatusChange

void enqueueStatusChange(UInt32 subscriptionId,
                         NotificationMessage message)