Module org.eclipse.milo.opcua.sdk.client
Package org.eclipse.milo.opcua.sdk.client.model.objects

Interface IVlanIdType

All Superinterfaces:
BaseInterfaceType, BaseObjectType, org.eclipse.milo.opcua.sdk.core.nodes.Node, org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode
All Known Implementing Classes:
IVlanIdTypeNode
public interface IVlanIdType extends BaseInterfaceType
See Also:

  • Method Summary

    Modifier and Type
    Method
    Description
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort
    getVlanId()
    Get the local value of the VlanId Node.
    BaseDataVariableType
    getVlanIdNode()
    Get the VlanId BaseDataVariableType Node, or null if it does not exist.
    CompletableFuture<? extends BaseDataVariableType>
    getVlanIdNodeAsync()
    Asynchronous implementation of getVlanIdNode().
    org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort
    readVlanId()
    Read the value of the VlanId Node from the server and update the local value if the operation succeeds.
    CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort>
    readVlanIdAsync()
    An asynchronous implementation of readVlanId().
    void
    setVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
    Set the local value of the VlanId Node.
    void
    writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
    Write a new value for the VlanId Node to the server and update the local value if the operation succeeds.
    CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode>
    writeVlanIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
    An asynchronous implementation of writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.Node

    getAccessRestrictions, getBrowseName, getDescription, getDisplayName, getNodeClass, getNodeId, getRolePermissions, getUserRolePermissions, getUserWriteMask, getWriteMask, setAccessRestrictions, setBrowseName, setDescription, setDisplayName, setNodeClass, setNodeId, setRolePermissions, setUserRolePermissions, setUserWriteMask, setWriteMask

    Methods inherited from interface org.eclipse.milo.opcua.sdk.core.nodes.ObjectNode

    getEventNotifier, setEventNotifier

  • Method Details

    • getVlanId

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort getVlanId() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the local value of the VlanId Node.

      The returned value is the last seen; it is not read live from the server.

      Returns:
      the local value of the VlanId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the VlanId Node.

    • setVlanId

      void setVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Set the local value of the VlanId Node.

      The value is only updated locally; it is not written to the server.

      Parameters:
      value - the local value to set for the VlanId Node.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the VlanId Node.

    • readVlanId

      org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort readVlanId() throws org.eclipse.milo.opcua.stack.core.UaException
      Read the value of the VlanId Node from the server and update the local value if the operation succeeds.
      Returns:
      the UShort value read from the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • writeVlanId

      void writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value) throws org.eclipse.milo.opcua.stack.core.UaException
      Write a new value for the VlanId Node to the server and update the local value if the operation succeeds.
      Parameters:
      value - the UShort value to write to the server.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if a service- or operation-level error occurs.

    • readVlanIdAsync

      CompletableFuture<? extends org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort> readVlanIdAsync()
      An asynchronous implementation of readVlanId().
      Returns:
      a CompletableFuture that completes successfully with the value or completes exceptionally if an operation- or service-level error occurs.

    • writeVlanIdAsync

      CompletableFuture<org.eclipse.milo.opcua.stack.core.types.builtin.StatusCode> writeVlanIdAsync(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort value)
      An asynchronous implementation of writeVlanId(org.eclipse.milo.opcua.stack.core.types.builtin.unsigned.UShort).
      Returns:
      a CompletableFuture that completes successfully with the operation result or completes exceptionally if a service-level error occurs.

    • getVlanIdNode

      BaseDataVariableType getVlanIdNode() throws org.eclipse.milo.opcua.stack.core.UaException
      Get the VlanId BaseDataVariableType Node, or null if it does not exist.

      The Node is created when first accessed and cached for subsequent calls.

      Returns:
      the VlanId BaseDataVariableType Node, or null if it does not exist.
      Throws:
      org.eclipse.milo.opcua.stack.core.UaException - if an error occurs creating or getting the Node.

    • getVlanIdNodeAsync

      CompletableFuture<? extends BaseDataVariableType> getVlanIdNodeAsync()
      Asynchronous implementation of getVlanIdNode().
      Returns:
      a CompletableFuture that completes successfully with the BaseDataVariableType Node or completes exceptionally if an error occurs creating or getting the Node.