net.user1.union.api
Interface UPCProcessingRecord


public interface UPCProcessingRecord

Contains information about the processing of a UPCMessage (the low level message structure used by the server).

See Also:
UPCEvent

Method Summary
 Client getClient()
          Returns the client that sent the UPC.
 long getProcessDuration()
          Returns the duration (in ms) the UPCMessage took to process.
 long getProcessFinishedAt()
          Returns the time the server finished processing the UPCMessage.
 long getProcessStartedAt()
          Returns the time the server started to process the UPCMessage.
 long getQueuedAt()
          Returns the time the server queued the UPCMessage for processing.
 long getQueuedDuration()
          Returns the duration (in ms) the UPCMessage was queued.
 long getTotalDuration()
          Returns the duration (in ms) from when the UPCMessage was retrieved to when it was finished processing.
 UPCMessage getUPC()
          Returns the UPCMessage that was sent.
 

Method Detail

getClient

Client getClient()
Returns the client that sent the UPC.

Returns:
the client that sent the UPC

getUPC

UPCMessage getUPC()
Returns the UPCMessage that was sent.

Returns:
the UPCMessage that was sent

getQueuedAt

long getQueuedAt()
Returns the time the server queued the UPCMessage for processing.

Returns:
the time the server queued the UPCMessage for processing

getProcessStartedAt

long getProcessStartedAt()
Returns the time the server started to process the UPCMessage.

Returns:
the time the server started to process the UPCMessage

getProcessFinishedAt

long getProcessFinishedAt()
Returns the time the server finished processing the UPCMessage.

Returns:
the time the server finished processing the UPCMessage

getQueuedDuration

long getQueuedDuration()
Returns the duration (in ms) the UPCMessage was queued.

Returns:
the duration (in ms) the UPCMessage was queued

getProcessDuration

long getProcessDuration()
Returns the duration (in ms) the UPCMessage took to process.

Returns:
the duration (in ms) the UPCMessage took to process

getTotalDuration

long getTotalDuration()
Returns the duration (in ms) from when the UPCMessage was retrieved to when it was finished processing. Effectively, getQueuedDuration() + getProcessDuration()

Returns:
the duration (in ms) from when the UPCMessage was retrieved to when it was finished processing


Copyright USER1 Subsystems Corporation - Tue Jan 28 2014, 05:05 PM -0500