PublicationImage (Aeron Transport Protocol)

java.lang.Object
- io.aeron.driver.PublicationImage

All Implemented Interfaces:

DriverManagedResource, LossHandler, org.agrona.ManagedResource
```
public class PublicationImage
extends java.lang.Object
implements LossHandler, DriverManagedResource
```
State maintained for active sessionIds within a channel for receiver processing

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`cleanPosition`
`protected long`	`lastPacketTimestamp`
`protected long`	`p1`
`protected long`	`p10`
`protected long`	`p11`
`protected long`	`p12`
`protected long`	`p13`
`protected long`	`p14`
`protected long`	`p15`
`protected long`	`p16`
`protected long`	`p17`
`protected long`	`p18`
`protected long`	`p19`
`protected long`	`p2`
`protected long`	`p20`
`protected long`	`p21`
`protected long`	`p22`
`protected long`	`p23`
`protected long`	`p24`
`protected long`	`p25`
`protected long`	`p26`
`protected long`	`p27`
`protected long`	`p28`
`protected long`	`p29`
`protected long`	`p3`
`protected long`	`p30`
`protected long`	`p31`
`protected long`	`p32`
`protected long`	`p33`
`protected long`	`p34`
`protected long`	`p35`
`protected long`	`p36`
`protected long`	`p37`
`protected long`	`p38`
`protected long`	`p39`
`protected long`	`p4`
`protected long`	`p40`
`protected long`	`p41`
`protected long`	`p42`
`protected long`	`p43`
`protected long`	`p44`
`protected long`	`p45`
`protected long`	`p5`
`protected long`	`p6`
`protected long`	`p7`
`protected long`	`p8`
`protected long`	`p9`

Constructor Summary

Constructors
Constructor and Description
PublicationImage(long correlationId, long imageLivenessTimeoutNs, ReceiveChannelEndpoint channelEndpoint, java.net.InetSocketAddress controlAddress, int sessionId, int streamId, int initialTermId, int activeTermId, int initialTermOffset, RawLog rawLog, FeedbackDelayGenerator lossFeedbackDelayGenerator, org.agrona.concurrent.status.ReadablePosition[] subscriberPositions, org.agrona.concurrent.status.Position hwmPosition, org.agrona.concurrent.status.Position rebuildPosition, org.agrona.concurrent.NanoClock nanoClock, org.agrona.concurrent.EpochClock epochClock, SystemCounters systemCounters, java.net.InetSocketAddress sourceAddress, CongestionControl congestionControl, LossReport lossReport, boolean isReliable)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`channelUriString()` Get the string representation of the channel URI.
`void`	`close()`
`long`	`correlationId()`
`void`	`delete()`
`boolean`	`hasReachedEndOfLife()` Has resource reached end of its life and should be reclaimed?
`boolean`	`isReliable()` Is the stream reliable in that is will NAK for loss or will it gap fill?
`boolean`	`matches(ReceiveChannelEndpoint channelEndpoint, int streamId)` Does this image match a given `ReceiveChannelEndpoint` and stream id?
`void`	`onGapDetected(int termId, int termOffset, int length)` Called from the `LossDetector` when gap is detected by the `DriverConductor` thread.
`void`	`onRttMeasurement(io.aeron.protocol.RttMeasurementFlyweight header, java.net.InetSocketAddress srcAddress)` Called from the `Receiver` upon receiving an RTT Measurement that is a reply.
`void`	`onTimeEvent(long timeNs, DriverConductor conductor)` Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
`void`	`scheduleStatusMessage(long now, long smPosition, int receiverWindowLength)`
`int`	`sessionId()` The session id of the channel from a publisher.
`io.aeron.driver.PublicationImage.Status`	`status()` Return status of the image.
`void`	`status(io.aeron.driver.PublicationImage.Status status)` Set status of the image.
`int`	`streamId()` The stream id of this image within a channel.
`long`	`timeOfLastStateChange()`
`void`	`timeOfLastStateChange(long time)`

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

Methods inherited from interface io.aeron.driver.DriverManagedResource
consumerPosition, decRef, incRef, producerPosition, unblockAtConsumerPosition

Field Detail

p31
```
protected long p31
```

p32
```
protected long p32
```

p33
```
protected long p33
```

p34
```
protected long p34
```

p35
```
protected long p35
```

p36
```
protected long p36
```

p37
```
protected long p37
```

p38
```
protected long p38
```

p39
```
protected long p39
```

p40
```
protected long p40
```

p41
```
protected long p41
```

p42
```
protected long p42
```

p43
```
protected long p43
```

p44
```
protected long p44
```

p45
```
protected long p45
```

lastPacketTimestamp
```
protected long lastPacketTimestamp
```

p16
```
protected long p16
```

p17
```
protected long p17
```

p18
```
protected long p18
```

p19
```
protected long p19
```

p20
```
protected long p20
```

p21
```
protected long p21
```

p22
```
protected long p22
```

p23
```
protected long p23
```

p24
```
protected long p24
```

p25
```
protected long p25
```

p26
```
protected long p26
```

p27
```
protected long p27
```

p28
```
protected long p28
```

p29
```
protected long p29
```

p30
```
protected long p30
```

cleanPosition
```
protected long cleanPosition
```

p1
```
protected long p1
```

p2
```
protected long p2
```

p3
```
protected long p3
```

p4
```
protected long p4
```

p5
```
protected long p5
```

p6
```
protected long p6
```

p7
```
protected long p7
```

p8
```
protected long p8
```

p9
```
protected long p9
```

p10
```
protected long p10
```

p11
```
protected long p11
```

p12
```
protected long p12
```

p13
```
protected long p13
```

p14
```
protected long p14
```

p15
```
protected long p15
```

Constructor Detail

PublicationImage

public PublicationImage(long correlationId,
                        long imageLivenessTimeoutNs,
                        ReceiveChannelEndpoint channelEndpoint,
                        java.net.InetSocketAddress controlAddress,
                        int sessionId,
                        int streamId,
                        int initialTermId,
                        int activeTermId,
                        int initialTermOffset,
                        RawLog rawLog,
                        FeedbackDelayGenerator lossFeedbackDelayGenerator,
                        org.agrona.concurrent.status.ReadablePosition[] subscriberPositions,
                        org.agrona.concurrent.status.Position hwmPosition,
                        org.agrona.concurrent.status.Position rebuildPosition,
                        org.agrona.concurrent.NanoClock nanoClock,
                        org.agrona.concurrent.EpochClock epochClock,
                        SystemCounters systemCounters,
                        java.net.InetSocketAddress sourceAddress,
                        CongestionControl congestionControl,
                        LossReport lossReport,
                        boolean isReliable)

Method Detail
- close
```
public void close()
```
- correlationId
```
public long correlationId()
```
- sessionId
```
public int sessionId()
```
  The session id of the channel from a publisher.
  
  Returns:
  
  session id of the channel from a publisher.
- streamId
```
public int streamId()
```
  The stream id of this image within a channel.
  
  Returns:
  
  stream id of this image within a channel.
- channelUriString
```
public java.lang.String channelUriString()
```
  Get the string representation of the channel URI.
  
  Returns:
  
  the string representation of the channel URI.
- matches
```
public boolean matches(ReceiveChannelEndpoint channelEndpoint,
                       int streamId)
```
  Does this image match a given ReceiveChannelEndpoint and stream id?
  
  Parameters:
  
  channelEndpoint - to match by identity.
  
  streamId - to match on value.
  
  Returns:
  
  true on a match otherwise false.
- status
```
public io.aeron.driver.PublicationImage.Status status()
```
  Return status of the image. Retrieved by DriverConductor.
  
  Returns:
  
  status of the image
- status
```
public void status(io.aeron.driver.PublicationImage.Status status)
```
  Set status of the image. Set by Receiver for INIT to ACTIVE to INACTIVE Set by DriverConductor for INACTIVE to LINGER
  
  Parameters:
  
  status - of the image
- isReliable
```
public boolean isReliable()
```
  Is the stream reliable in that is will NAK for loss or will it gap fill?
  
  Returns:
  
  true if it will attempt to recover loss or false if it will gap fill.
- onGapDetected
```
public void onGapDetected(int termId,
                          int termOffset,
                          int length)
```
  Called from the LossDetector when gap is detected by the DriverConductor thread.
  
  Specified by:
  
  onGapDetected in interface LossHandler
  
  Parameters:
  
  termId - for the gap
  
  termOffset - for the beginning of the gap
  
  length - of the gap
  
  See Also:
  
  LossHandler
- scheduleStatusMessage
```
public void scheduleStatusMessage(long now,
                                  long smPosition,
                                  int receiverWindowLength)
```
- onRttMeasurement
```
public void onRttMeasurement(io.aeron.protocol.RttMeasurementFlyweight header,
                             java.net.InetSocketAddress srcAddress)
```
  Called from the Receiver upon receiving an RTT Measurement that is a reply.
  
  Parameters:
  
  header - of the measurement
  
  srcAddress - from the sender of the measurement
- onTimeEvent
```
public void onTimeEvent(long timeNs,
                        DriverConductor conductor)
```
  Description copied from interface: DriverManagedResource
  
  Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
  
  Specified by:
  
  onTimeEvent in interface DriverManagedResource
  
  Parameters:
  
  timeNs - now in nanoseconds
  
  conductor - to inform of any state transitions
- hasReachedEndOfLife
```
public boolean hasReachedEndOfLife()
```
  Description copied from interface: DriverManagedResource
  
  Has resource reached end of its life and should be reclaimed?
  
  Specified by:
  
  hasReachedEndOfLife in interface DriverManagedResource
  
  Returns:
  
  whether resource has reached end of life or not
- timeOfLastStateChange
```
public void timeOfLastStateChange(long time)
```
  Specified by:
  
  timeOfLastStateChange in interface org.agrona.ManagedResource
- timeOfLastStateChange
```
public long timeOfLastStateChange()
```
  Specified by:
  
  timeOfLastStateChange in interface org.agrona.ManagedResource
- delete
```
public void delete()
```
  Specified by:
  
  delete in interface org.agrona.ManagedResource

Class PublicationImage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface io.aeron.driver.DriverManagedResource

Field Detail

p31

p32

p33

p34

p35

p36

p37

p38

p39

p40

p41

p42

p43

p44

p45

lastPacketTimestamp

p16

p17

p18

p19

p20

p21

p22

p23

p24

p25

p26

p27

p28

p29

p30

cleanPosition

p1

p2

p3

p4

p5

p6

p7

p8

p9

p10

p11

p12

p13

p14

p15

Constructor Detail

PublicationImage

Method Detail

close

correlationId

sessionId

streamId

channelUriString

matches

status

status

isReliable

onGapDetected

scheduleStatusMessage

onRttMeasurement

onTimeEvent

hasReachedEndOfLife

timeOfLastStateChange

timeOfLastStateChange

delete