gnu.io.rfc2217.ControlCommand Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of nrjavaserial Show documentation
Show all versions of nrjavaserial Show documentation
A fork of the RXTX library with a focus on ease of use and embeddability in other libraries.
/*
* Copyright (C) 2010 Archie L. Cobbs. All rights reserved.
*
* $Id: ControlCommand.java 39 2011-03-22 17:21:53Z archie.cobbs $
*/
package gnu.io.rfc2217;
import static gnu.io.rfc2217.RFC2217.COM_PORT_OPTION;
import static gnu.io.rfc2217.RFC2217.CONTROL_BREAK_OFF;
import static gnu.io.rfc2217.RFC2217.CONTROL_BREAK_ON;
import static gnu.io.rfc2217.RFC2217.CONTROL_BREAK_REQUEST;
import static gnu.io.rfc2217.RFC2217.CONTROL_DTR_OFF;
import static gnu.io.rfc2217.RFC2217.CONTROL_DTR_ON;
import static gnu.io.rfc2217.RFC2217.CONTROL_DTR_REQUEST;
import static gnu.io.rfc2217.RFC2217.CONTROL_INBOUND_FLOW_DTR;
import static gnu.io.rfc2217.RFC2217.CONTROL_INBOUND_FLOW_HARDWARE;
import static gnu.io.rfc2217.RFC2217.CONTROL_INBOUND_FLOW_NONE;
import static gnu.io.rfc2217.RFC2217.CONTROL_INBOUND_FLOW_REQUEST;
import static gnu.io.rfc2217.RFC2217.CONTROL_INBOUND_FLOW_XON_XOFF;
import static gnu.io.rfc2217.RFC2217.CONTROL_OUTBOUND_FLOW_DCD;
import static gnu.io.rfc2217.RFC2217.CONTROL_OUTBOUND_FLOW_DSR;
import static gnu.io.rfc2217.RFC2217.CONTROL_OUTBOUND_FLOW_HARDWARE;
import static gnu.io.rfc2217.RFC2217.CONTROL_OUTBOUND_FLOW_NONE;
import static gnu.io.rfc2217.RFC2217.CONTROL_OUTBOUND_FLOW_REQUEST;
import static gnu.io.rfc2217.RFC2217.CONTROL_OUTBOUND_FLOW_XON_XOFF;
import static gnu.io.rfc2217.RFC2217.CONTROL_RTS_OFF;
import static gnu.io.rfc2217.RFC2217.CONTROL_RTS_ON;
import static gnu.io.rfc2217.RFC2217.CONTROL_RTS_REQUEST;
import static gnu.io.rfc2217.RFC2217.SERVER_OFFSET;
import static gnu.io.rfc2217.RFC2217.SET_CONTROL;
/**
* RFC 2217 {@code SET-CONTROL} command.
*
* @see RFC 2217
*/
public class ControlCommand extends ComPortCommand {
private int control;
/**
* Decoding constructor.
*
* @param bytes encoded option starting with the {@code COM-PORT-OPTION} byte
* NullPointerException if {@code bytes} is null
* IllegalArgumentException if {@code bytes} has length != 3
* IllegalArgumentException if {@code bytes[0]} is not {@link RFC2217#COM_PORT_OPTION}
* IllegalArgumentException if {@code bytes[1]} is not {@link RFC2217#SET_CONTROL} (client or server)
* IllegalArgumentException if {@code bytes[2]} is not a valid RFC 2217 control value
*/
public ControlCommand(int[] bytes) {
super("SET-CONTROL", SET_CONTROL, bytes);
this.control = bytes[2];
switch (this.control) {
case CONTROL_OUTBOUND_FLOW_REQUEST:
case CONTROL_OUTBOUND_FLOW_NONE:
case CONTROL_OUTBOUND_FLOW_XON_XOFF:
case CONTROL_OUTBOUND_FLOW_HARDWARE:
case CONTROL_BREAK_REQUEST:
case CONTROL_BREAK_ON:
case CONTROL_BREAK_OFF:
case CONTROL_DTR_REQUEST:
case CONTROL_DTR_ON:
case CONTROL_DTR_OFF:
case CONTROL_RTS_REQUEST:
case CONTROL_RTS_ON:
case CONTROL_RTS_OFF:
case CONTROL_INBOUND_FLOW_REQUEST:
case CONTROL_INBOUND_FLOW_NONE:
case CONTROL_INBOUND_FLOW_XON_XOFF:
case CONTROL_INBOUND_FLOW_HARDWARE:
case CONTROL_OUTBOUND_FLOW_DCD:
case CONTROL_INBOUND_FLOW_DTR:
case CONTROL_OUTBOUND_FLOW_DSR:
break;
default:
throw new IllegalArgumentException("invalid control value " + this.control);
}
}
/**
* Encoding constructor.
*
* @param command control command
* @param client true for the client-to-server command, false for the server-to-client command
* IllegalArgumentException if {@code command} is not a valid RFC 2217 control value
*/
public ControlCommand(boolean client, int command) {
this(new int[] {
COM_PORT_OPTION,
client ? SET_CONTROL : SET_CONTROL + SERVER_OFFSET,
command
});
}
@Override
public String toString() {
String desc;
switch (this.control) {
case CONTROL_OUTBOUND_FLOW_REQUEST:
desc = "OUTBOUND-FLOW-REQUEST";
break;
case CONTROL_OUTBOUND_FLOW_NONE:
desc = "OUTBOUND-FLOW-NONE";
break;
case CONTROL_OUTBOUND_FLOW_XON_XOFF:
desc = "OUTBOUND-FLOW-XON-XOFF";
break;
case CONTROL_OUTBOUND_FLOW_HARDWARE:
desc = "OUTBOUND-FLOW-HARDWARE";
break;
case CONTROL_BREAK_REQUEST:
desc = "OUTBOUND-BREAK-REQUEST";
break;
case CONTROL_BREAK_ON:
desc = "OUTBOUND-BREAK-ON";
break;
case CONTROL_BREAK_OFF:
desc = "OUTBOUND-BREAK-OFF";
break;
case CONTROL_DTR_REQUEST:
desc = "OUTBOUND-DTR-REQUEST";
break;
case CONTROL_DTR_ON:
desc = "OUTBOUND-DTR-ON";
break;
case CONTROL_DTR_OFF:
desc = "OUTBOUND-DTR-OFF";
break;
case CONTROL_RTS_REQUEST:
desc = "OUTBOUND-RTS-REQUEST";
break;
case CONTROL_RTS_ON:
desc = "OUTBOUND-RTS-ON";
break;
case CONTROL_RTS_OFF:
desc = "OUTBOUND-RTS-OFF";
break;
case CONTROL_INBOUND_FLOW_REQUEST:
desc = "INBOUND-FLOW-REQUEST";
break;
case CONTROL_INBOUND_FLOW_NONE:
desc = "INBOUND-FLOW-NONE";
break;
case CONTROL_INBOUND_FLOW_XON_XOFF:
desc = "INBOUND-FLOW-XON-OFF";
break;
case CONTROL_INBOUND_FLOW_HARDWARE:
desc = "INBOUND-FLOW-HARDWARE";
break;
case CONTROL_OUTBOUND_FLOW_DCD:
desc = "OUTBOUND-FLOW-DCD";
break;
case CONTROL_INBOUND_FLOW_DTR:
desc = "INBOUND-FLOW-DTR";
break;
case CONTROL_OUTBOUND_FLOW_DSR:
desc = "OUTBOUND-FLOW-DSR";
break;
default:
desc = "?";
break;
}
return this.getName() + " " + desc;
}
@Override
public void visit(ComPortCommandSwitch sw) {
sw.caseControl(this);
}
public int getControl() {
return this.control;
}
@Override
int getMinPayloadLength() {
return 1;
}
@Override
int getMaxPayloadLength() {
return 1;
}
}