The ProcessConnectionConfigurationSets Method causes the ConnectionManager to process the requested ConnectionConfigurationSets according to the specified Action:
- ActionEstablishConnectionsEnabled, ActionEstablishConnectionsDisabled, and ActionEstablishConnections – establish all Connections contained in the ConnectionConfigurationSets (see 6.7.5.3)
- ActionRemoveConnections – disable and remove all Connections contained in the ConnectionConfigurationSets (see 6.7.5.3.2)
- ActionEnableConnections – enable the communication model for all Connections contained in the ConnectionConfigurationSets (see 6.7.5.3.3)
- ActionDisableConnections – disable the communication model for all Connections contained in the ConnectionConfigurationSets (see 6.7.5.3.4)
The ProcessConnectionConfigurationSets Method shall initiate the ReadyToProcessing or ErrorToProcessing transition in the ConnectionConfigurationSetStateMachine (see 6.9) on all requested ConnectionConfigurationSets.
The Method triggers the processing and returns immediately. The result of processing is “returned” asynchronously by one of the ConnectionConfigurationSetEventType Events.
The signature of this Method is specified below; the Method arguments are defined in Table 80.
Signature
ProcessConnectionConfigurationSets (
[in] 4:FxProcessEnumAction,
[in] 0:NodeId[] ConnectionConfigurationSets,
[out] 0:StatusCode[]Results
);
Table 80 – ProcessConnectionConfigurationSets Method arguments
Argument |
Description |
Action |
The operation to be performed on the ConnectionConfigurationSets (see 10.23). |
ConnectionConfigurationSets |
A list of NodeIds of ConnectionConfigurationSets to be processed. |
Results |
The array of StatusCode corresponding to the ConnectionConfigurationSets input argument. The length of this array shall match the length of the ConnectionConfigurationSets NodeId array. Clients may inspect this list to determine the status of the individual Call to Trigger processing on each ConnectionConfigurationSets. For possible values for StatusCode, see Table 82. |
The possible Method result codes are formally defined in Table 81.
Table 81 – ProcessConnectionConfigurationSets Method result codes
ResultCode |
Description |
Bad_UserAccessDenied |
The caller is not allowed to invoke this Method. |
Bad_NotSupported |
The requested Action is not supported. |
Uncertain |
There was at least one error or warning for one of the ConnectionConfigurationSets. Results will contain additional information. |
The possible Result StatusCodes are formally defined in Table 82.
Table 82 – Results StatusCodes
Result Code |
Description |
Good |
Changing the State succeeded for the ConnectionConfigurationSet. |
Bad_NodeIdInvalid |
The syntax of the NodeId is not valid. |
Bad_NodeIdUnknown |
The NodeId refers to a node that does not exist in the Server address space. |
Bad_InvalidArgument |
The NodeId for the requested ConnectionConfigurationSet was not a ConnectionConfigurationSet. |
Bad_UserAccessDenied |
The caller is not allowed to trigger processing of this ConnectionConfigurationSet. |
Bad_InvalidState |
The ConnectionConfigurationSet is in a State that does not allow it to be triggered for processing. |
The ProcessConnectionConfigurationSets Method representation in the AddressSpace is formally defined in Table 83.
Table 83 – ProcessConnectionConfigurationSets Method AddressSpace definition
Attribute |
Value |
||||
BrowseName |
4:ProcessConnectionConfigurationSets |
||||
References |
Node Class |
BrowseName |
DataType |
TypeDefinition |
Other |
0:HasProperty |
Variable |
0:InputArguments |
0:Argument[] |
0:PropertyType |
M |
0:HasProperty |
Variable |
0:OutputArguments |
0:Argument[] |
0:PropertyType |
M |
0:GeneratesEvent |
ObjectType |
2:AuditUpdateMethodResultEventType |
Defined in 8.4 |
|
|
ConformanceUnits |
|||||
UAFX ConnectionManager ProcessConnectionConfigurationSets |
Calling ProcessConnectionConfigurationSets with Action set to ActionEstablishConnectionsEnabled, ActionEstablishConnectionsDisabled, or ActionEstablishConnections shall establish the Connections contained in the ConnectionConfigurationSets and their related communication model.
Establishing connections shall follow the behaviour specified in 6.7.3.2.
The ConnectionManager shall ensure the expected result of the requested Action as follows:
- Calling ProcessConnectionConfigurationSets with Action set to ActionEstablishConnectionsEnabled shall establish all Connections contained in the ConnectionConfigurationSets with a disabled communication model and include EnableCommunicationCmd in the command sequence. A disabled communication model has Enabled flags set to FALSE for all DataSetReader and DataSetWriter configuration elements and to TRUE for all other elements (WriterGroup, ReaderGroup, PubSubConnection, and PublishSubscribe).
A disabled ClientServer communication model may be defined in a future version of this document.
- Calling ProcessConnectionConfigurationSets with Action set to ActionEstablishConnectionsDisabled shall establish all Connections contained in the ConnectionConfigurationSets with a disabled communication model and omit EnableCommunicationCmd from the command sequence. A disabled communication model has Enabled flags set to FALSE for all DataSetReader and DataSetWriter configuration elements and to TRUE for all other elements (WriterGroup, ReaderGroup, PubSubConnection, and PublishSubscribe).
Calling ProcessConnectionConfigurationSets with Action set to ActionEstablishConnections shall establish all Connections contained in the ConnectionConfigurationSets with the communication model as configured by the engineering tool generating the communication model. The ConnectionManager shall apply the communication model as is using the SetCommunicationConfigurationCmd and omit EnableCommunicationCmd from the command sequence. Depending on the state of the configuration elements (e.g., the value of the Enabled flag for PubSub configuration elements), parts of the communication model may be enabled and others disabled. This allows, for example, to have a subset of the Connections enabled and the rest disabled. It is the responsibility of the engineering tool to configure the state of the configuration elements properly and consistently.
Calling ProcessConnectionConfigurationSets with Action set to ActionRemoveConnections shall remove all Connections contained in the ConnectionConfigurationSets and their related communication model.
For each ConnectionConfigurationSet, the ConnectionManager shall call the CloseConnections Method (see 6.2.5) with Remove set to TRUE for all contained ConnectionEndpoints. See 6.7.3.3 for ConnectionManager behaviour.
Calling ProcessConnectionConfigurationSets with Action set to ActionEnableConnections shall enable all Connections contained in the ConnectionConfigurationSets.
For each ConnectionConfigurationSet, the ConnectionManager shall call the EstablishConnections Method containing the EnableCommunicationCmd for all contained ConnectionEndpoints. See 6.7.3.2 for ConnectionManager behaviour.
Calling ProcessConnectionConfigurationSets with Action set to ActionDisableConnections shall disable all Connections contained in the ConnectionConfigurationSets.
For each ConnectionConfigurationSet, the ConnectionManager shall call the CloseConnections Method (see 6.2.5) with Remove set to FALSE for all contained ConnectionEndpoints. See 6.7.3.3 for ConnectionManager behaviour.