MessageReceivedJob | Javadocs [I2P+]

java.lang.Object

net.i2p.router.JobImpl

net.i2p.router.client.MessageReceivedJob

All Implemented Interfaces:: Job

class MessageReceivedJobextends JobImpl

Async job to notify the client that a new message is available for them, or just send it directly if specified.

Field Summary
Fields inherited from class JobImpl
_id
Modifier and Type
Field
Description
final long
_id
Unique job identifier.
Constructor Summary
Constructors
Constructor
Description
MessageReceivedJob(RouterContext ctx, ClientConnectionRunner runner, Destination toDest, Destination fromDest, Payload payload, boolean sendDirect)
Create a job that delivers one received message to a client.
Method Summary
All Methods
Modifier and Type
Method
Description
String
getName()
Descriptive name of the task.
boolean
receiveMessage()
Same as runJob() but with a return value.
void
runJob()
Actually perform the task.
Methods inherited from class JobImpl
dropped, getContext, getJobId, getMadeReadyOn, getTiming, madeReady, requeue, toString
Modifier and Type
Method
Description
void
dropped()
Default implementation does nothing.
final RouterContext
getContext()
The router context that this job belongs to.
long
getJobId()
The unique job ID for this job.
long
getMadeReadyOn()
The timestamp when this job was last made ready for execution.
JobTiming
getTiming()
The timing object for this job.
void
madeReady(long now)
For JobQueue only, not for external use.
protected void
requeue(long delayMs)
Requeue this job to run after the specified delay.
String
toString()

Methods inherited from class Object
clone, equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Details
- MessageReceivedJob
  public MessageReceivedJob(RouterContext ctx, ClientConnectionRunner runner, Destination toDest, Destination fromDest, Payload payload, boolean sendDirect)
  Create a job that delivers one received message to a client.
  Parameters:
  ctx - the router context
  runner - the client connection runner
  toDest - non-null, required to pick session
  fromDest - sending destination, generally null
  payload - the message payload
  sendDirect - if true send directly
Method Details
- getName
  public String getName()
  Description copied from interface: Job
  Descriptive name of the task.
  Returns:
  the descriptive name of the task
- runJob
  public void runJob()
  Description copied from interface: Job
  Actually perform the task. This call blocks until the Job is complete.
- receiveMessage
  public boolean receiveMessage()
  Same as runJob() but with a return value.
  Returns:
  true if the payload was handed over, false if the runner is dead or the send threw