com.digitalpetri.enip.cip.structs.ForwardOpenRequest Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of enip-client Show documentation
There is a newer version: 1.5.0-RC1
package com.digitalpetri.enip.cip.structs;

import com.digitalpetri.enip.cip.epath.EPath;
import com.digitalpetri.enip.util.TimeoutCalculator;
import io.netty.buffer.ByteBuf;

import java.time.Duration;
import java.util.concurrent.TimeUnit;

public final class ForwardOpenRequest {

    private final Duration timeout;
    private final int o2tConnectionId;
    private final int t2oConnectionId;
    private final int connectionSerialNumber;
    private final int vendorId;
    private final long vendorSerialNumber;
    private final int connectionTimeoutMultiplier;
    private final EPath.PaddedEPath connectionPath;
    private final Duration o2tRpi;
    private final NetworkConnectionParameters o2tParameters;
    private final Duration t2oRpi;
    private final NetworkConnectionParameters t2oParameters;
    private final int transportClassAndTrigger;

    public ForwardOpenRequest(Duration timeout,
                              int o2tConnectionId,
                              int t2oConnectionId,
                              int connectionSerialNumber,
                              int vendorId,
                              long vendorSerialNumber,
                              int connectionTimeoutMultiplier,
                              EPath.PaddedEPath connectionPath,
                              Duration o2tRpi,
                              NetworkConnectionParameters o2tParameters,
                              Duration t2oRpi,
                              NetworkConnectionParameters t2oParameters,
                              int transportClassAndTrigger) {

        this.timeout = timeout;
        this.o2tConnectionId = o2tConnectionId;
        this.t2oConnectionId = t2oConnectionId;
        this.connectionSerialNumber = connectionSerialNumber;
        this.vendorId = vendorId;
        this.vendorSerialNumber = vendorSerialNumber;
        this.connectionTimeoutMultiplier = connectionTimeoutMultiplier;
        this.connectionPath = connectionPath;
        this.o2tRpi = o2tRpi;
        this.o2tParameters = o2tParameters;
        this.t2oRpi = t2oRpi;
        this.t2oParameters = t2oParameters;
        this.transportClassAndTrigger = transportClassAndTrigger;
    }

    public Duration getTimeout() {
        return timeout;
    }

    public int getO2tConnectionId() {
        return o2tConnectionId;
    }

    public int getT2oConnectionId() {
        return t2oConnectionId;
    }

    public int getConnectionSerialNumber() {
        return connectionSerialNumber;
    }

    public int getVendorId() {
        return vendorId;
    }

    public long getVendorSerialNumber() {
        return vendorSerialNumber;
    }

    public int getConnectionTimeoutMultiplier() {
        return connectionTimeoutMultiplier;
    }

    public EPath.PaddedEPath getConnectionPath() {
        return connectionPath;
    }

    public Duration getO2tRpi() {
        return o2tRpi;
    }

    public NetworkConnectionParameters getO2tParameters() {
        return o2tParameters;
    }

    public Duration getT2oRpi() {
        return t2oRpi;
    }

    public NetworkConnectionParameters getT2oParameters() {
        return t2oParameters;
    }

    public int getTransportClassAndTrigger() {
        return transportClassAndTrigger;
    }

    public static ByteBuf encode(ForwardOpenRequest request, ByteBuf buffer) {
        int priorityAndTimeoutBytes = TimeoutCalculator.calculateTimeoutBytes(request.timeout);
        buffer.writeByte(priorityAndTimeoutBytes >> 8 & 0xFF);
        buffer.writeByte(priorityAndTimeoutBytes & 0xFF);

        buffer.writeInt(0); // o2tConnectionId chosen by remote and indicated in response
        buffer.writeInt(request.t2oConnectionId);
        buffer.writeShort(request.connectionSerialNumber);

        buffer.writeShort(request.vendorId);
        buffer.writeInt((int) request.vendorSerialNumber);

        buffer.writeByte(request.connectionTimeoutMultiplier);
        buffer.writeZero(3); // 3 reserved bytes

        buffer.writeInt((int) TimeUnit.MICROSECONDS.convert(request.o2tRpi.toMillis(), TimeUnit.MILLISECONDS));
        buffer.writeShort(parametersToInt(request.o2tParameters));

        buffer.writeInt((int) TimeUnit.MICROSECONDS.convert(request.t2oRpi.toMillis(), TimeUnit.MILLISECONDS));
        buffer.writeShort(parametersToInt(request.t2oParameters));

        buffer.writeByte(request.transportClassAndTrigger);

        EPath.PaddedEPath.encode(request.connectionPath, buffer);

        return buffer;
    }

    private static int parametersToInt(NetworkConnectionParameters parameters) {
        int parametersInt = parameters.getConnectionSize() & 0x1FF;

        parametersInt |= (parameters.getSizeType().ordinal() << 9);
        parametersInt |= (parameters.getPriority().ordinal() << 10);
        parametersInt |= (parameters.getConnectionType().ordinal() << 13);
        if (parameters.isRedundantOwner()) parametersInt |= (1 << 15);

        return parametersInt;
    }

}