org.jmythapi.protocol.response
Interface IRingBuffer

All Superinterfaces:

Cloneable, Closeable, IPropertyAware<IRingBuffer.Props>, ITransferable<IRingBuffer.Props>, IVersionable

All Known Implementing Classes:

RingBuffer

Deprecated. 20

public interface IRingBuffer
extends ITransferable<IRingBuffer.Props>

An interface to control a MythTV ringbuffer.

This interface represents the result of a IRecorder.annotateRingBuffer() request.
This interface is property-aware. See the properties-list for all properties of this interface.

Nested Class Summary

static class

IRingBuffer.Props Deprecated. The properties of an IRingBuffer response.

Nested classes/interfaces inherited from interface org.jmythapi.protocol.response.ITransferable

ITransferable.Seek

Method Summary

void	close() Deprecated. Closes the ringbuffer connection.
boolean	done() Deprecated. 20
long	getAmount() Deprecated.
long	getFreeSpace(long totalReadPos) Deprecated. 20
long	getSize() Deprecated.
String	getUrl() Deprecated.
boolean	isOpen() Deprecated. Queries whether the ring buffer connection is open.
int	readBlock(byte[] buffer, int requestedSize) Deprecated. 20
long	seek(long currentPos, long newPos, ITransferable.Seek whence) Deprecated. 20

Methods inherited from interface org.jmythapi.IVersionable

getVersionNr

Methods inherited from interface org.jmythapi.IPropertyAware

getProperties, getProperty, getPropertyClass, getPropertyCount, getPropertyIndex, getPropertyMap, getPropertyValue, getPropertyValue, getPropertyValueObject, getPropertyValues, setPropertyValue, setPropertyValue, setPropertyValueObject

Method Detail

getUrl

String getUrl()

Deprecated.

getSize

long getSize()

Deprecated.

getAmount

long getAmount()

Deprecated.

seek

long seek(long currentPos,
          long newPos,
          ITransferable.Seek whence)
          throws IOException

Deprecated. 20

Seeks to the given position in the ring buffer.

Specified by:

seek in interface ITransferable<IRingBuffer.Props>

Parameters:

currentPos - the current position

whence - the seek mode

newPos - the new position

Throws:

IOException - on communication errors

Since:

00

See Also:

QUERY_RECORDER_SEEK_RINGBUF

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

readBlock

int readBlock(byte[] buffer,
              int requestedSize)
              throws IOException

Deprecated. 20

Requests a block from the ring-buffer.

Specified by:

readBlock in interface ITransferable<IRingBuffer.Props>

Parameters:

buffer - the byte array that should be filled with data

requestedSize - the amount of bytes to read.

Throws:

IOException - on communication errors

Since:

00

See Also:

QUERY_RECORDER_REQUEST_BLOCK_RINGBUF

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

getFreeSpace

long getFreeSpace(long totalReadPos)
                  throws IOException

Deprecated. 20

Queries bytes available to read.

This function returns the number of bytes beyond "totalreadpos" it is safe to read.

Parameters:

totalReadPos - amount of already read bytes

Returns:

the number of bytes beyond "totalReadPos" it is save to read or -1 if "totalReadPos" is past the "safe read" position of the file.

Throws:

IOException

See Also:

QUERY_RECORDER_GET_FREE_SPACE

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

done

boolean done()
             throws IOException

Deprecated. 20

Tells the recorder to free the ring buffer.

Specified by:

done in interface ITransferable<IRingBuffer.Props>

Returns:

true if the recorder respond with OK.

Throws:

IOException - on communication errors

Since:

00

MythTV protocol range: [00,20)

	Version	Date	Additional Version Info
Added	00
Removed	20	2005-11-05	Changelog, SVN-Rev.: 7739

close

void close()
           throws IOException

Deprecated.

Closes the ringbuffer connection.

Specified by:

close in interface Closeable

Specified by:

close in interface ITransferable<IRingBuffer.Props>

Throws:

IOException - on communication errors

isOpen

boolean isOpen()
               throws IOException

Deprecated.

Queries whether the ring buffer connection is open.

Specified by:

isOpen in interface ITransferable<IRingBuffer.Props>

Returns:

true if the socket is open.

Throws:

IOException - on communication errors