Class TelnetSocket

java.lang.Object

java.net.Socket

org.prelle.telnet.TelnetSocket

All Implemented Interfaces:

Closeable, AutoCloseable, TelnetConstants

public class TelnetSocket
extends Socket
implements TelnetConstants

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	TelnetSocket.State

Nested classes/interfaces inherited from interface org.prelle.telnet.TelnetConstants

TelnetConstants.ControlCode

Field Summary

Fields inherited from interface org.prelle.telnet.TelnetConstants

DO, DONT, EOR, IAC, IP, SB, SE, WILL, WONT

Constructor Summary

Constructors

Constructor	Description
TelnetSocket()
TelnetSocket(String host, int port)

Method Summary

Modifier and Type	Method	Description
TelnetSocket	addSocketListener(TelnetSocketListener optList)
void	fireTelnetCommand(TelnetCommand command)
List<Integer>	getActiveOptions()
Set<Map.Entry<TelnetOption,TelnetConfigOption>>	getCapabilities()
TelnetConfigOption	getConfigOption(TelnetOption key)
static ExecutorService	getExecutorService()
InputStream	getInputStream()
TelnetOptionCapabilities	getNegotiationResult()
<E> E	getOptionData(int code)	Retrieve data related to a specific config option on this connection
<E extends TelnetOptionListener> E	getOptionListener(int code)
OutputStream	getOutputStream()
CompletableFuture<TelnetOptionCapabilities>	initialize()
boolean	isFeatureActive(int code)
boolean	isFeatureSupported(TelnetOption option)
TelnetOutputStream	out()
void	processSubnegotiation(int code, int[] values)
void	setOptionData(int code, Object value)	Store data related to a specific config option on this connection
TelnetSocket	setOptionListener(int code, TelnetOptionListener callback)
TelnetSocket	setOptionListener(TelnetOption option, TelnetOptionListener callback)
void	subnegotiationEndedFor(int optionCode, Object data)	Called by TelnetSubnegotiationHandler implementor classes
TelnetSocket	support(int code, TelnetConstants.ControlCode willOrDo)
TelnetSocket	support(int code, TelnetConstants.ControlCode willOrDo, Object configData)

Methods inherited from class java.net.Socket

bind, close, connect, connect, getChannel, getInetAddress, getKeepAlive, getLocalAddress, getLocalPort, getLocalSocketAddress, getOOBInline, getOption, getPort, getReceiveBufferSize, getRemoteSocketAddress, getReuseAddress, getSendBufferSize, getSoLinger, getSoTimeout, getTcpNoDelay, getTrafficClass, isBound, isClosed, isConnected, isInputShutdown, isOutputShutdown, sendUrgentData, setKeepAlive, setOOBInline, setOption, setPerformancePreferences, setReceiveBufferSize, setReuseAddress, setSendBufferSize, setSocketImplFactory, setSoLinger, setSoTimeout, setTcpNoDelay, setTrafficClass, shutdownInput, shutdownOutput, supportedOptions, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details

TelnetSocket

public TelnetSocket()

TelnetSocket

public TelnetSocket(String host,
 int port)
             throws UnknownHostException,
IOException

Throws:

UnknownHostException

IOException

Method Details

getExecutorService

public static ExecutorService getExecutorService()

getConfigOption

public TelnetConfigOption getConfigOption(TelnetOption key)

getCapabilities

public Set<Map.Entry<TelnetOption,TelnetConfigOption>> getCapabilities()

getInputStream

public InputStream getInputStream()
                           throws IOException

Overrides:

getInputStream in class Socket

Throws:

IOException

See Also:

• Socket.getInputStream()

getOutputStream

public OutputStream getOutputStream()
                             throws IOException

Overrides:

getOutputStream in class Socket

Throws:

IOException

See Also:

• Socket.getOutputStream()

out

public TelnetOutputStream out()
                       throws IOException

Throws:

IOException

support

public TelnetSocket support(int code,
 TelnetConstants.ControlCode willOrDo)

support

public TelnetSocket support(int code,
 TelnetConstants.ControlCode willOrDo,
 Object configData)

addSocketListener

public TelnetSocket addSocketListener(TelnetSocketListener optList)

setOptionListener

public TelnetSocket setOptionListener(int code,
 TelnetOptionListener callback)

setOptionListener

public TelnetSocket setOptionListener(TelnetOption option,
 TelnetOptionListener callback)

getOptionListener

public <E extends TelnetOptionListener> E getOptionListener(int code)

getOptionData

public <E> E getOptionData(int code)

Retrieve data related to a specific config option on this connection

setOptionData

public void setOptionData(int code,
 Object value)

Store data related to a specific config option on this connection

fireTelnetCommand

public void fireTelnetCommand(TelnetCommand command)

isFeatureActive

public boolean isFeatureActive(int code)

isFeatureSupported

public boolean isFeatureSupported(TelnetOption option)

processSubnegotiation

public void processSubnegotiation(int code,
 int[] values)

initialize

public CompletableFuture<TelnetOptionCapabilities> initialize()
                                                       throws IOException

Throws:

IOException

subnegotiationEndedFor

public void subnegotiationEndedFor(int optionCode,
 Object data)

Called by TelnetSubnegotiationHandler implementor classes

getNegotiationResult

public TelnetOptionCapabilities getNegotiationResult()

getActiveOptions

public List<Integer> getActiveOptions()