com.realtime.xmpp.streams
Interface XmlStream

All Known Implementing Classes:

SocketStreamFactory.SocketStream

public interface XmlStream

Represents a bidirectional stream carrying XML data.

Version:

1.0 Copyright © 2002 Real Time Entertainment Group, LLC - All rights reserved.

Author:

Mike Prince

Method Summary

void	close() Close this connection in both directions.
java.io.InputStream	getInputStream() Provide an input stream for reading data from the endpoint.
java.lang.String	getName() Provides a name for the stream.
java.io.OutputStream	getOutputStream() Provide a byte stream for writing data to the endpoint.
boolean	isClosed() Determine if this connection has been closed.

Method Detail

getName

public java.lang.String getName()

Provides a name for the stream. This is implementation dependent, and may be the endpoints DNS hostname, an IP address, or a familiar name such as a Jabber service.

* @return A name for the stream.

getInputStream

public java.io.InputStream getInputStream()
                                   throws java.io.IOException

Provide an input stream for reading data from the endpoint.

* @return An InputStream to read data from. * @throws IOException Generated when the input stream could not be created.

java.io.IOException

getOutputStream

public java.io.OutputStream getOutputStream()
                                     throws java.io.IOException

Provide a byte stream for writing data to the endpoint.

* @return An OutputStream for writing data. * @throws IOException Generated when an output stream is not available.

java.io.IOException

close

public void close()
           throws java.io.IOException

Close this connection in both directions.

* @throws IOException Generated when there are problems closing the connection.

java.io.IOException

isClosed

public boolean isClosed()

Determine if this connection has been closed.

Returns:

True if the connection has been closed.