PublicationImage (Aeron Message Transport)

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

All Implemented Interfaces:

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

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`cleanPosition`
`protected ImageConnection[]`	`imageConnections`
`protected boolean`	`isEndOfStream`
`protected long`	`lastPacketTimestampNs`
`protected LossReport`	`lossReport`
`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`
`protected LossReport.ReportEntry`	`reportEntry`
`protected org.agrona.concurrent.status.ReadablePosition[]`	`subscriberPositions`

Constructor Summary

Constructors
Constructor and Description
PublicationImage(long correlationId, long imageLivenessTimeoutNs, ReceiveChannelEndpoint channelEndpoint, int transportIndex, 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.NanoClock cachedNanoClock, org.agrona.concurrent.EpochClock cachedEpochClock, 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
`void`	`addSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)` Add a new subscriber to this image so their position can be tracked for flow control.
`java.lang.String`	`channel()` Get the string representation of the channel URI.
`void`	`close()` Close resources that are not external.
`long`	`correlationId()`
`boolean`	`free()` Free external resources such as files.
`boolean`	`hasReachedEndOfLife()` Has resource reached end of its life and should be reclaimed?
`void`	`onGapDetected(int termId, int termOffset, int length)` Called from the `LossDetector` when gap is detected by the `DriverConductor` thread.
`void`	`onTimeEvent(long timeNs, long timesMs, DriverConductor conductor)` Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
`void`	`removeSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)` Remove a `ReadablePosition` for a subscriber that has been removed so it is not tracked for flow control.
`int`	`sessionId()` The session id of the channel from a publisher.
`int`	`streamId()` The stream id of this image within a channel.

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

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
```

isEndOfStream
```
protected boolean isEndOfStream
```

lastPacketTimestampNs
```
protected long lastPacketTimestampNs
```

imageConnections

protected ImageConnection[] imageConnections

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
```

subscriberPositions

protected org.agrona.concurrent.status.ReadablePosition[] subscriberPositions

lossReport
```
protected LossReport lossReport
```

reportEntry

protected LossReport.ReportEntry reportEntry

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,
                        int transportIndex,
                        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.NanoClock cachedNanoClock,
                        org.agrona.concurrent.EpochClock cachedEpochClock,
                        SystemCounters systemCounters,
                        java.net.InetSocketAddress sourceAddress,
                        CongestionControl congestionControl,
                        LossReport lossReport,
                        boolean isReliable)

Method Detail
- free
```
public boolean free()
```
  Description copied from interface: DriverManagedResource
  
  Free external resources such as files. if successful then return true.
  
  Specified by:
  
  free in interface DriverManagedResource
  
  Returns:
  
  true if successful and false if it should be attempted again later.
- close
```
public void close()
```
  Close resources that are not external.
  
  Specified by:
  
  close in interface DriverManagedResource
- 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.
- channel
```
public java.lang.String channel()
```
  Get the string representation of the channel URI.
  
  Returns:
  
  the string representation of the channel URI.
- removeSubscriber
```
public void removeSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)
```
  Remove a ReadablePosition for a subscriber that has been removed so it is not tracked for flow control.
  
  Specified by:
  
  removeSubscriber in interface Subscribable
  
  Parameters:
  
  subscriberPosition - for the subscriber that has been removed.
- addSubscriber
```
public void addSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)
```
  Add a new subscriber to this image so their position can be tracked for flow control.
  
  Specified by:
  
  addSubscriber in interface Subscribable
  
  Parameters:
  
  subscriberPosition - for the subscriber to be added.
- 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
- onTimeEvent
```
public void onTimeEvent(long timeNs,
                        long timesMs,
                        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
  
  timesMs - now in milliseconds for epoch
  
  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

Class PublicationImage

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

p31

p32

p33

p34

p35

p36

p37

p38

p39

p40

p41

p42

p43

p44

p45

isEndOfStream

lastPacketTimestampNs

imageConnections

p16

p17

p18

p19

p20

p21

p22

p23

p24

p25

p26

p27

p28

p29

p30

cleanPosition

subscriberPositions

lossReport

reportEntry

p1

p2

p3

p4

p5

p6

p7

p8

p9

p10

p11

p12

p13

p14

p15

Constructor Detail

PublicationImage

Method Detail

free

close

correlationId

sessionId

streamId

channel

removeSubscriber

addSubscriber

onGapDetected

onTimeEvent

hasReachedEndOfLife