NetworkPublication (Aeron Transport Protocol)

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

All Implemented Interfaces:

DriverManagedResource, RetransmitSender, Subscribable, org.agrona.ManagedResource
```
public class NetworkPublication
extends java.lang.Object
implements RetransmitSender, DriverManagedResource, Subscribable
```
Publication to be sent to registered subscribers.

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static class NetworkPublication.Status

Nested Classes
Modifier and Type	Class and Description
`static class`	`NetworkPublication.Status`

Field Summary

Fields
Modifier and Type	Field and Description
`protected long`	`cleanPosition`
`protected long`	`lastConsumerPosition`
`protected long`	`lastSenderPosition`
`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 int`	`refCount`
`protected boolean`	`shouldSendSetupFrame`
`protected org.agrona.concurrent.status.ReadablePosition[]`	`spyPositions`
`protected long`	`timeOfLastActivity`
`protected long`	`timeOfLastConsumerPositionChange`
`protected long`	`timeOfLastSendOrHeartbeat`
`protected long`	`timeOfLastSetup`
`protected boolean`	`trackSenderLimits`

Constructor Summary

Constructors
Constructor and Description
NetworkPublication(long registrationId, SendChannelEndpoint channelEndpoint, org.agrona.concurrent.NanoClock nanoClock, org.agrona.concurrent.EpochClock epochClock, RawLog rawLog, org.agrona.concurrent.status.Position publisherLimit, org.agrona.concurrent.status.Position senderPosition, org.agrona.concurrent.status.Position senderLimit, int sessionId, int streamId, int initialTermId, int mtuLength, SystemCounters systemCounters, FlowControl flowControl, RetransmitHandler retransmitHandler, NetworkPublicationThreadLocals threadLocals, long unblockTimeoutNs, boolean isExclusive)

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addSubscriber(org.agrona.concurrent.status.ReadablePosition spyPosition)` Add a subscriber identified by its position.
`SendChannelEndpoint`	`channelEndpoint()`
`void`	`close()`
`long`	`consumerPosition()` Position of the consumer for this resource.
`int`	`decRef()` Decrement reference count to this resource.
`void`	`delete()`
`boolean`	`hasReachedEndOfLife()` Has resource reached end of its life and should be reclaimed?
`int`	`incRef()` Increment reference count to this resource.
`boolean`	`isExclusive()`
`int`	`mtuLength()`
`void`	`onNak(int termId, int termOffset, int length)`
`void`	`onRttMeasurement(io.aeron.protocol.RttMeasurementFlyweight msg, java.net.InetSocketAddress srcAddress)`
`void`	`onStatusMessage(io.aeron.protocol.StatusMessageFlyweight msg, java.net.InetSocketAddress srcAddress)`
`void`	`onTimeEvent(long timeNs, long timeMs, DriverConductor conductor)` Inform resource of timeNs passing and pass it DriverConductor to inform of any state transitions.
`long`	`producerPosition()` Position of the producer for this resource.
`long`	`registrationId()`
`void`	`removeSubscriber(org.agrona.concurrent.status.ReadablePosition spyPosition)` Remove a subscriber identified by its position.
`void`	`resend(int termId, int termOffset, int length)` Called when a retransmit should be sent
`int`	`send(long now)`
`int`	`sessionId()`
`NetworkPublication.Status`	`status()`
`int`	`streamId()`
`long`	`timeOfLastStateChange()`
`void`	`timeOfLastStateChange(long time)`
`void`	`triggerSendSetupFrame()`
`boolean`	`unblockAtConsumerPosition()` Unblock the resource at consumer position.

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

timeOfLastSendOrHeartbeat

protected long timeOfLastSendOrHeartbeat

timeOfLastSetup
```
protected long timeOfLastSetup
```

trackSenderLimits
```
protected boolean trackSenderLimits
```

shouldSendSetupFrame
```
protected boolean shouldSendSetupFrame
```

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

timeOfLastActivity
```
protected long timeOfLastActivity
```

lastSenderPosition
```
protected long lastSenderPosition
```

lastConsumerPosition
```
protected long lastConsumerPosition
```

timeOfLastConsumerPositionChange

protected long timeOfLastConsumerPositionChange

refCount
```
protected int refCount
```

spyPositions

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

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

NetworkPublication

public NetworkPublication(long registrationId,
                          SendChannelEndpoint channelEndpoint,
                          org.agrona.concurrent.NanoClock nanoClock,
                          org.agrona.concurrent.EpochClock epochClock,
                          RawLog rawLog,
                          org.agrona.concurrent.status.Position publisherLimit,
                          org.agrona.concurrent.status.Position senderPosition,
                          org.agrona.concurrent.status.Position senderLimit,
                          int sessionId,
                          int streamId,
                          int initialTermId,
                          int mtuLength,
                          SystemCounters systemCounters,
                          FlowControl flowControl,
                          RetransmitHandler retransmitHandler,
                          NetworkPublicationThreadLocals threadLocals,
                          long unblockTimeoutNs,
                          boolean isExclusive)

Method Detail
- close
```
public void close()
```
- mtuLength
```
public int mtuLength()
```
- registrationId
```
public long registrationId()
```
- isExclusive
```
public boolean isExclusive()
```
- send
```
public int send(long now)
```
- channelEndpoint
```
public SendChannelEndpoint channelEndpoint()
```
- sessionId
```
public int sessionId()
```
- streamId
```
public int streamId()
```
- resend
```
public void resend(int termId,
                   int termOffset,
                   int length)
```
  Description copied from interface: RetransmitSender
  
  Called when a retransmit should be sent
  
  Specified by:
  
  resend in interface RetransmitSender
  
  Parameters:
  
  termId - for the NAK
  
  termOffset - for the NAK
  
  length - for the NAK
- triggerSendSetupFrame
```
public void triggerSendSetupFrame()
```
- addSubscriber
```
public void addSubscriber(org.agrona.concurrent.status.ReadablePosition spyPosition)
```
  Description copied from interface: Subscribable
  
  Add a subscriber identified by its position.
  
  Specified by:
  
  addSubscriber in interface Subscribable
  
  Parameters:
  
  spyPosition - for tracking and identifying the subscriber.
- removeSubscriber
```
public void removeSubscriber(org.agrona.concurrent.status.ReadablePosition spyPosition)
```
  Description copied from interface: Subscribable
  
  Remove a subscriber identified by its position. Note: The Subscribable is responsible for calling ReadablePosition.close() on removed positions.
  
  Specified by:
  
  removeSubscriber in interface Subscribable
  
  Parameters:
  
  spyPosition - to be identified by.
- onNak
```
public void onNak(int termId,
                  int termOffset,
                  int length)
```
- onStatusMessage
```
public void onStatusMessage(io.aeron.protocol.StatusMessageFlyweight msg,
                            java.net.InetSocketAddress srcAddress)
```
- onRttMeasurement
```
public void onRttMeasurement(io.aeron.protocol.RttMeasurementFlyweight msg,
                             java.net.InetSocketAddress srcAddress)
```
- onTimeEvent
```
public void onTimeEvent(long timeNs,
                        long timeMs,
                        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
  
  timeMs - 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
- 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
- decRef
```
public int decRef()
```
  Description copied from interface: DriverManagedResource
  
  Decrement reference count to this resource.
  
  Specified by:
  
  decRef in interface DriverManagedResource
  
  Returns:
  
  new reference count value
- incRef
```
public int incRef()
```
  Description copied from interface: DriverManagedResource
  
  Increment reference count to this resource.
  
  Specified by:
  
  incRef in interface DriverManagedResource
  
  Returns:
  
  new reference count value
- status
```
public NetworkPublication.Status status()
```
- producerPosition
```
public long producerPosition()
```
  Description copied from interface: DriverManagedResource
  
  Position of the producer for this resource.
  
  Specified by:
  
  producerPosition in interface DriverManagedResource
  
  Returns:
  
  position of the producer
- consumerPosition
```
public long consumerPosition()
```
  Description copied from interface: DriverManagedResource
  
  Position of the consumer for this resource.
  
  Specified by:
  
  consumerPosition in interface DriverManagedResource
  
  Returns:
  
  position of the consumer
- unblockAtConsumerPosition
```
public boolean unblockAtConsumerPosition()
```
  Description copied from interface: DriverManagedResource
  
  Unblock the resource at consumer position.
  
  Specified by:
  
  unblockAtConsumerPosition in interface DriverManagedResource
  
  Returns:
  
  whether unblocking was necessary or not

Class NetworkPublication

Nested Class Summary

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

timeOfLastSendOrHeartbeat

timeOfLastSetup

trackSenderLimits

shouldSendSetupFrame

p16

p17

p18

p19

p20

p21

p22

p23

p24

p25

p26

p27

p28

p29

p30

cleanPosition

timeOfLastActivity

lastSenderPosition

lastConsumerPosition

timeOfLastConsumerPositionChange

refCount

spyPositions

p1

p2

p3

p4

p5

p6

p7

p8

p9

p10

p11

p12

p13

p14

p15

Constructor Detail

NetworkPublication

Method Detail

close

mtuLength

registrationId

isExclusive

send

channelEndpoint

sessionId

streamId

resend

triggerSendSetupFrame

addSubscriber

removeSubscriber

onNak

onStatusMessage