ByteStreamSession (Babbler 0.5.1)

java.lang.Object
- rocks.xmpp.extensions.bytestreams.ByteStreamSession

All Implemented Interfaces:

AutoCloseable
```
public abstract class ByteStreamSession
extends Object
implements AutoCloseable
```
An abstract byte stream session, which either represents a XEP-0047: In-Band Bytestreams or XEP-0065: SOCKS5 Bytestreams session.
Both kind of sessions have a session id and are bidirectional, that's why this class has an input and output stream.

See Also:
InBandByteStreamManager.initiateSession(rocks.xmpp.core.Jid, String, int), Socks5ByteStreamManager.initiateSession(rocks.xmpp.core.Jid, String), ByteStreamEvent.accept()

Constructor Summary

Constructors
Constructor and Description

ByteStreamSession(String sessionId)

Constructors
Constructor and Description
`ByteStreamSession(String sessionId)`

Method Summary

Methods
Modifier and Type	Method and Description
`abstract InputStream`	`getInputStream()` Gets the input stream.
`abstract OutputStream`	`getOutputStream()` Gets the output stream.
`abstract int`	`getReadTimeout()` Gets the timeout (in milliseconds) for read operations on the input stream.
`String`	`getSessionId()` Gets the session id for this byte stream session.
`abstract void`	`setReadTimeout(int readTimeout)` Sets the timeout (in milliseconds).

Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.AutoCloseable
close

- Constructor Detail
  - ByteStreamSession
```
public ByteStreamSession(String sessionId)
```
- Method Detail
  - getOutputStream
```
public abstract OutputStream getOutputStream()
                                      throws IOException
```
    Gets the output stream.
    
    Returns:
    The output stream.
    
    Throws:
    
    IOException - If an I/O error occurs when creating the output stream or the session is closed.
  - getInputStream
```
public abstract InputStream getInputStream()
                                    throws IOException
```
    Gets the input stream.
    
    Returns:
    The input stream.
    
    Throws:
    
    IOException - If an I/O error occurs when creating the input stream or the session is closed.
  - getSessionId
```
public final String getSessionId()
```
    Gets the session id for this byte stream session.
    
    Returns:
    The session id.
  - getReadTimeout
```
public abstract int getReadTimeout()
                            throws IOException
```
    Gets the timeout (in milliseconds) for read operations on the input stream. The default timeout is 0, i.e. infinite. Read operations will therefore block forever, unless the session is closed.
    
    Returns:
    The read timeout.
    
    Throws:
    
    IOException - If an I/O error occurred.
    See Also:
    setReadTimeout(int)
  - setReadTimeout
```
public abstract void setReadTimeout(int readTimeout)
                             throws IOException
```
    Sets the timeout (in milliseconds).
    
    Parameters:
    readTimeout - The read timeout.
    
    Throws:
    
    IOException - If an I/O error occurred.
    See Also:
    getReadTimeout()

Class ByteStreamSession

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.AutoCloseable

Constructor Detail

ByteStreamSession

Method Detail

getOutputStream

getInputStream

getSessionId

getReadTimeout

setReadTimeout