1 /*
2 * Licensed to the Apache Software Foundation (ASF) under one
3 * or more contributor license agreements. See the NOTICE file
4 * distributed with this work for additional information
5 * regarding copyright ownership. The ASF licenses this file
6 * to you under the Apache License, Version 2.0 (the
7 * "License"); you may not use this file except in compliance
8 * with the License. You may obtain a copy of the License at
9 *
10 * http://www.apache.org/licenses/LICENSE-2.0
11 *
12 * Unless required by applicable law or agreed to in writing,
13 * software distributed under the License is distributed on an
14 * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15 * KIND, either express or implied. See the License for the
16 * specific language governing permissions and limitations
17 * under the License.
18 *
19 */
20 package org.apache.mina.transport.serial;
21
22 import org.apache.mina.core.session.IoSession;
23
24 /**
25 * An {@link IoSession} for serial communication transport.
26 *
27 * @author <a href="http://mina.apache.org">Apache MINA Project</a>
28 */
29 public interface SerialSession extends IoSession {
30 SerialSessionConfig getConfig();
31
32 SerialAddress getRemoteAddress();
33
34 SerialAddress getLocalAddress();
35
36 SerialAddress getServiceAddress();
37
38 /**
39 * Sets or clears the RTS (Request To Send) bit in the UART, if supported by the underlying implementation.
40 * @param rts true for set RTS, false for clearing
41 */
42 void setRTS(boolean rts);
43
44 /**
45 * @return the state of the RTS (Request To Send) bit in the UART, if supported by the underlying implementation.
46 */
47 boolean isRTS();
48
49 /**
50 * Sets or clears the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation.
51 *
52 * @param dtr true for set DTR, false for clearing
53 */
54 void setDTR(boolean dtr);
55
56 /**
57 * @return the state of the DTR (Data Terminal Ready) bit in the UART, if supported by the underlying implementation.
58 */
59 boolean isDTR();
60 }