Package org.cometd.server.http

Class AbstractHttpTransport.LongPollScheduler

java.lang.Object

org.cometd.server.http.AbstractHttpTransport.LongPollScheduler

All Implemented Interfaces:

jakarta.servlet.AsyncListener, java.lang.Runnable, java.util.EventListener, AbstractServerTransport.Scheduler, AbstractHttpTransport.HttpScheduler

Direct Known Subclasses:

AbstractStreamHttpTransport.DispatchingLongPollScheduler

Enclosing class:

AbstractHttpTransport

protected abstract class AbstractHttpTransport.LongPollScheduler
extends java.lang.Object
implements java.lang.Runnable, AbstractHttpTransport.HttpScheduler, jakarta.servlet.AsyncListener

Nested Class Summary

Nested classes/interfaces inherited from interface org.cometd.server.AbstractServerTransport.Scheduler

AbstractServerTransport.Scheduler.None

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	LongPollScheduler(AbstractHttpTransport.Context context, Promise<java.lang.Void> promise, ServerMessage.Mutable message, long timeout)

Method Summary

Modifier and Type	Method	Description
void	cancel(java.lang.Throwable cause)	Invoked when the transport wants to cancel with the given cause scheduled operations that will trigger when the /meta/connect timeout fires.
void	destroy()	Invoked when the transport wants to abort communication.
protected abstract void	dispatch(boolean timeout)
AbstractHttpTransport.Context	getContext()
ServerMessage.Mutable	getMessage()
long	getMetaConnectCycle()
Promise<java.lang.Void>	getPromise()
void	onComplete(jakarta.servlet.AsyncEvent asyncEvent)
void	onError(jakarta.servlet.AsyncEvent event)
void	onStartAsync(jakarta.servlet.AsyncEvent event)
void	onTimeout(jakarta.servlet.AsyncEvent event)
void	run()
void	schedule()	Invoked when the transport wants to send queued messages, and possibly a /meta/connect reply.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.cometd.server.AbstractServerTransport.Scheduler

cancel

Constructor Detail

LongPollScheduler

protected LongPollScheduler(AbstractHttpTransport.Context context,
                            Promise<java.lang.Void> promise,
                            ServerMessage.Mutable message,
                            long timeout)

Method Detail

getContext

public AbstractHttpTransport.Context getContext()

getPromise

public Promise<java.lang.Void> getPromise()

getMessage

public ServerMessage.Mutable getMessage()

Specified by:

getMessage in interface AbstractServerTransport.Scheduler

Returns:

the message associated with this scheduler.

getMetaConnectCycle

public long getMetaConnectCycle()

Specified by:

getMetaConnectCycle in interface AbstractServerTransport.Scheduler

Returns:

the cycle number for suspended /meta/connects.

schedule

public void schedule()

Description copied from interface: AbstractServerTransport.Scheduler

Invoked when the transport wants to send queued messages, and possibly a /meta/connect reply.

Specified by:

schedule in interface AbstractServerTransport.Scheduler

cancel

public void cancel(java.lang.Throwable cause)

Description copied from interface: AbstractServerTransport.Scheduler

Invoked when the transport wants to cancel with the given cause scheduled operations that will trigger when the /meta/connect timeout fires.

Specified by:

cancel in interface AbstractServerTransport.Scheduler

destroy

public void destroy()

Description copied from interface: AbstractServerTransport.Scheduler

Invoked when the transport wants to abort communication.

Specified by:

destroy in interface AbstractServerTransport.Scheduler

run

public void run()

Specified by:

run in interface java.lang.Runnable

onStartAsync

public void onStartAsync(jakarta.servlet.AsyncEvent event)

Specified by:

onStartAsync in interface jakarta.servlet.AsyncListener

onTimeout

public void onTimeout(jakarta.servlet.AsyncEvent event)

Specified by:

onTimeout in interface jakarta.servlet.AsyncListener

onComplete

public void onComplete(jakarta.servlet.AsyncEvent asyncEvent)
                throws java.io.IOException

Specified by:

onComplete in interface jakarta.servlet.AsyncListener

Throws:

java.io.IOException

onError

public void onError(jakarta.servlet.AsyncEvent event)

Specified by:

onError in interface jakarta.servlet.AsyncListener

dispatch

protected abstract void dispatch(boolean timeout)

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object