RecordingDescriptor (Aeron Message Transport)

java.lang.Object
- io.aeron.samples.archive.RecordingDescriptor

```
public class RecordingDescriptor
extends Object
```
Class that collects the parameters of the RecordingDescriptor Consumer callback for use with the RecordingDescriptorCollector

See Also:

RecordingDescriptorConsumer, RecordingDescriptorCollector

Constructor Summary

Constructors
Constructor and Description

RecordingDescriptor()

Constructors
Constructor and Description
`RecordingDescriptor()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`long`	`controlSessionId()` controlSessionId of the originating session requesting to list recordings.
`long`	`correlationId()` correlationId of the associated request to list recordings.
`int`	`initialTermId()` initialTermId of the recorded stream, `Image.initialTermId()`.
`boolean`	`isRetained()` Has this instance been retained to prevent reuse.
`int`	`mtuLength()` mtuLength of the recorded stream, `Image.mtuLength()`.
`String`	`originalChannel()` originalChannel of the recorded stream provided to the start recording request, `Subscription.channel()`.
`long`	`recordingId()` recordingId of this recording descriptor.
`RecordingDescriptor`	`retain()` Indicate that this descriptor instance should not be returned to the pool for reuse.
`int`	`segmentFileLength()` segmentFileLength of the recording which is a multiple of termBufferLength.
`int`	`sessionId()` sessionId of the recorded stream, this will be the most recent session id for extended recordings.
`String`	`sourceIdentity()` sourceIdentity of the recorded stream, the `Image.sourceIdentity()`.
`long`	`startPosition()` startPosition of the recording against the recorded publication, the `Image.joinPosition()`
`long`	`startTimestamp()` startTimestamp of the recording.
`long`	`stopPosition()` stopPosition reached for the recording, final position for `Image.position()`.
`long`	`stopTimestamp()` stopTimestamp of the recording.
`int`	`streamId()` streamId of the recorded stream, `Subscription.streamId()`.
`String`	`strippedChannel()` strippedChannel of the recorded stream which is used for the recording subscription in the archive.
`int`	`termBufferLength()` termBufferLength of the recorded stream, `Image.termBufferLength()`.
`String`	`toString()`

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

- Constructor Detail
  - RecordingDescriptor
```
public RecordingDescriptor()
```
- Method Detail
  - controlSessionId
```
public long controlSessionId()
```
    controlSessionId of the originating session requesting to list recordings.
    
    Returns:
    
    controlSessionId
  - correlationId
```
public long correlationId()
```
    correlationId of the associated request to list recordings.
    
    Returns:
    
    correlationId
  - recordingId
```
public long recordingId()
```
    recordingId of this recording descriptor.
    
    Returns:
    
    recordingId
  - startTimestamp
```
public long startTimestamp()
```
    startTimestamp of the recording.
    
    Returns:
    
    startTimestamp
  - stopTimestamp
```
public long stopTimestamp()
```
    stopTimestamp of the recording.
    
    Returns:
    
    stopTimestamp
  - startPosition
```
public long startPosition()
```
    startPosition of the recording against the recorded publication, the Image.joinPosition()
    
    Returns:
    
    startPosition
  - stopPosition
```
public long stopPosition()
```
    stopPosition reached for the recording, final position for Image.position().
    
    Returns:
    
    stopPosition
  - initialTermId
```
public int initialTermId()
```
    initialTermId of the recorded stream, Image.initialTermId().
    
    Returns:
    
    initialTermId
  - segmentFileLength
```
public int segmentFileLength()
```
    segmentFileLength of the recording which is a multiple of termBufferLength.
    
    Returns:
    
    segmentFileLength
  - termBufferLength
```
public int termBufferLength()
```
    termBufferLength of the recorded stream, Image.termBufferLength().
    
    Returns:
    
    termBufferLength
  - mtuLength
```
public int mtuLength()
```
    mtuLength of the recorded stream, Image.mtuLength().
    
    Returns:
    
    mtuLength
  - sessionId
```
public int sessionId()
```
    sessionId of the recorded stream, this will be the most recent session id for extended recordings.
    
    Returns:
    
    sessionId
  - streamId
```
public int streamId()
```
    streamId of the recorded stream, Subscription.streamId().
    
    Returns:
    
    streamId
  - strippedChannel
```
public String strippedChannel()
```
    strippedChannel of the recorded stream which is used for the recording subscription in the archive.
    
    Returns:
    
    strippedChannel
  - originalChannel
```
public String originalChannel()
```
    originalChannel of the recorded stream provided to the start recording request, Subscription.channel().
    
    Returns:
    
    originalChannel
  - sourceIdentity
```
public String sourceIdentity()
```
    sourceIdentity of the recorded stream, the Image.sourceIdentity().
    
    Returns:
    
    sourceIdentity
  - retain
```
public RecordingDescriptor retain()
```
    Indicate that this descriptor instance should not be returned to the pool for reuse.
    
    Returns:
    
    this for a fluent API.
  - isRetained
```
public boolean isRetained()
```
    Has this instance been retained to prevent reuse.
    
    Returns:
    
    true if this instance has been flagged to be excluded from the pool.
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class RecordingDescriptor

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

RecordingDescriptor

Method Detail

controlSessionId

correlationId

recordingId

startTimestamp

stopTimestamp

startPosition

stopPosition

initialTermId

segmentFileLength

termBufferLength

mtuLength

sessionId

streamId

strippedChannel

originalChannel

sourceIdentity

retain

isRetained

toString