Add transport-{api,tcp}
[netconf.git] / transport / transport-tcp / src / main / java / org / opendaylight / netconf / transport / tcp / package-info.java
1 /*
2  * Copyright (c) 2022 PANTHEON.tech, s.r.o. and others.  All rights reserved.
3  *
4  * This program and the accompanying materials are made available under the
5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6  * and is available at http://www.eclipse.org/legal/epl-v10.html
7  */
8 /**
9  * TCP transport layer. This does not constitute a {@code NETCONF Secure Transport}, but rather captures common aspects
10  * of TCP-based secure transports, such as SSH and TLS. Configuration follows
11  * <a href="https://datatracker.ietf.org/doc/html/draft-ietf-netconf-tcp-client-server-13">
12  * draft-ietf-netconf-tcp-client-server</a>.
13  *
14  * <p>
15  * While this is strictly not a secure transport, it provides a TransportStack and thus can be used as is, for example
16  * for testing purposes.
17  *
18  * <p>
19  * The three primary entry points into this package are {@link NettyTransportSupport}, {@link TCPClient} and
20  * {@link TCPServer}.
21  */
22 package org.opendaylight.netconf.transport.tcp;