com.github.dockerjava.core.command

Class FrameReader

java.lang.Object

com.github.dockerjava.core.command.FrameReader

All Implemented Interfaces:

java.lang.AutoCloseable

public class FrameReader
extends java.lang.Object
implements java.lang.AutoCloseable

Breaks the input into frame. Similar to how a buffered reader would readLies.

See: http://docs.docker.com/v1.6/reference/api/docker_remote_api_v1.13/#attach-to-a-container}

Constructor Summary

Constructors

Constructor and Description
FrameReader(java.io.InputStream inputStream)

Method Summary

Modifier and Type	Method and Description
void	close()
Frame	readFrame()

Methods inherited from class java.lang.Object

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

Constructor Detail

FrameReader

public FrameReader(java.io.InputStream inputStream)

Method Detail

readFrame

@CheckForNull
public Frame readFrame()
                              throws java.io.IOException

Returns:

A frame, or null if no more frames.

Throws:

java.io.IOException

close

public void close()
           throws java.io.IOException

Specified by:

close in interface java.lang.AutoCloseable

Throws:

java.io.IOException