io.aeron.driver

Class IpcPublication

java.lang.Object

io.aeron.driver.IpcPublication

All Implemented Interfaces:

DriverManagedResource, Subscribable, org.agrona.ManagedResource

public class IpcPublication
extends java.lang.Object
implements DriverManagedResource, Subscribable

Encapsulation of a LogBuffer used directly between publishers and subscribers for IPC.

Constructor Summary

Constructors

Constructor and Description
IpcPublication(long registrationId, int sessionId, int streamId, org.agrona.concurrent.status.Position publisherLimit, RawLog rawLog, long unblockTimeoutNs, SystemCounters systemCounters, boolean isExclusive)

Method Summary

Modifier and Type	Method and Description
void	addSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition) Add a subscriber identified by its position.
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()
long	joiningPosition()
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.
int	publisherLimitId()
RawLog	rawLog()
long	registrationId()
void	removeSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition) Remove a subscriber identified by its position.
int	sessionId()
int	streamId()
long	timeOfLastStateChange()
void	timeOfLastStateChange(long time)
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

Constructor Detail

IpcPublication

public IpcPublication(long registrationId,
                      int sessionId,
                      int streamId,
                      org.agrona.concurrent.status.Position publisherLimit,
                      RawLog rawLog,
                      long unblockTimeoutNs,
                      SystemCounters systemCounters,
                      boolean isExclusive)

Method Detail

sessionId

public int sessionId()

streamId

public int streamId()

registrationId

public long registrationId()

isExclusive

public boolean isExclusive()

rawLog

public RawLog rawLog()

publisherLimitId

public int publisherLimitId()

close

public void close()

addSubscriber

public void addSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)

Description copied from interface: Subscribable

Add a subscriber identified by its position.

Specified by:

addSubscriber in interface Subscribable

Parameters:

subscriberPosition - for tracking and identifying the subscriber.

removeSubscriber

public void removeSubscriber(org.agrona.concurrent.status.ReadablePosition subscriberPosition)

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:

subscriberPosition - to be identified by.

joiningPosition

public long joiningPosition()

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

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

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

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

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