9.1.3.7.5 ReserveIds Method
This Method reserves unique WriterGroupIds and DataSetWriterIds to allow PubSub configuration applications to apply unique Ids to new PubSub configuration elements when preparing a update to the PubSub configuration. It also returns the related default PublisherId. See 6.2.7.1 for more details on PublisherId and default values.
The ID shall be returned from the range 0x8000 - 0xFFFF for internal assignment. The Server shall ensure that the IDs returned are not used in the current PubSub configuration or are not reserved yet.
When a Client reserves IDs, these reservations are valid while the Session is open. The reserved IDs can only be used for configuration modifications through the same Session. The reservation is only valid until the ID is used in the configuration or until the Session is closed. The IDs can be re-used if a PubSub component that uses the ID is deleted.
The Client shall be authorized to modify the configuration for the PubSub functionality when invoking this Method on the Server.
Signature
ReserveIds (
[in] String TransportProfileUri,
[in] UInt16 NumReqWriterGroupIds,
[in] UInt16 NumReqDataSetWriterIds,
[out] BaseDataType DefaultPublisherId,
[out] UInt16[] WriterGroupIds,
[out] UInt16[] DataSetWriterIds
);
| Argument | Description |
| TransportProfileUri | Transport protocol and message mapping profile scope for the ID request. |
| NumReqWriterGroupIds | The number of requested Ids for WriterGroups. |
| NumReqDataSetWriterIds | The number of requested Ids for DataSetWriters. |
| DefaultPublisherId | The default PublisherId of the Server for the requested TransportProfileUri. |
| WriterGroupIds | The reserved Ids for WriterGroups for the requested TransportProfileUri. |
| DataSetWriterIds | The reserved Ids for DataSetWriters for the requested TransportProfileUri |
Method Result Codes
| ResultCode | Description |
| Bad_UserAccessDenied | The Session user is not allowed to modify the PubSub configuration. |
| Bad_ResourceUnavailable | The requested number of Ids cannot be reserved. The maximum number of WriterGroups and DataSetWriters are exposed in the PubSubCapabilities Object. |
Table 245 specifies the AddressSpace representation for the ReserveIds Method.
| Attribute | Value | ||||
| BrowseName | ReserveIds | ||||
| References | NodeClass | BrowseName | DataType | TypeDefinition | ModellingRule |
|---|---|---|---|---|---|
| HasProperty | Variable | InputArguments | Argument[] | PropertyType | Mandatory |
| HasProperty | Variable | OutputArguments | Argument[] | PropertyType | Mandatory |
| ConformanceUnits | |||||
|---|---|---|---|---|---|
| PubSub Model Base |