Class TimesyncExtension
- All Implemented Interfaces:
BayeuxServer.Extension
public class TimesyncExtension extends BayeuxServer.Extension.Adapter
Timesync extension (server side).
With each handshake or connect, the extension sends timestamps within the ext
field like: {ext:{timesync:{tc:12345567890,l:23,o:4567},...},...} where:
- tc is the client timestamp in ms since 1970 of when the message was sent.
- l is the network lag that the client has calculated.
- o is the clock offset that the client has calculated.
A CometD server that supports timesync, can respond with an ext field like:
{ext:{timesync:{tc:12345567890,ts:1234567900,p:123,a:3},...},...} where:
- tc is the client timestamp of when the message was sent,
- ts is the server timestamp of when the message was received
- p is the poll duration in ms - ie the time the server took before sending the response.
- a is the measured accuracy of the calculated offset and lag sent by the client
The relationship between tc, ts, o and l on the server is given by
ts=tc+o+l (the time the server received the message is the
client time plus the offset plus the network lag). Thus the accuracy of the o
and l settings can be determined with a=tc+o+l-ts.
When the client has received the response, it can make a more accurate
estimate of the lag as l2=(now-tc-p)/2 (assuming symmetric lag).
A new offset can then be calculated with the relationship on the client that
ts=tc+o2+l2, thus o2=ts-tc-l2.
Since the client also receives the a value calculated on the server, it should be possible to analyse this and compensate for some asymmetry in the lag. But the current client does not do this.
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.cometd.bayeux.server.BayeuxServer.Extension
BayeuxServer.Extension.Adapter -
Field Summary
Fields Modifier and Type Field Description static StringLAG_ATTRIBUTE -
Constructor Summary
Constructors Constructor Description TimesyncExtension() -
Method Summary
Modifier and Type Method Description intgetAccuracyTarget()timesync responses are not set if the measured accuracy is less than the accuracyTarget.booleanrcvMeta(ServerSession from, ServerMessage.Mutable message)Callback method invoked every time a meta message is incoming.booleansendMeta(ServerSession session, ServerMessage.Mutable message)Callback method invoked every time a meta message is outgoing.voidsetAccuracyTarget(int target)timesync responses are not set if the measured accuracy is less than the accuracyTarget.
-
Field Details
-
LAG_ATTRIBUTE
- See Also:
- Constant Field Values
-
-
Constructor Details
-
TimesyncExtension
public TimesyncExtension()
-
-
Method Details
-
getAccuracyTarget
public int getAccuracyTarget()timesync responses are not set if the measured accuracy is less than the accuracyTarget.- Returns:
- accuracy target in ms (default 25ms)
-
setAccuracyTarget
public void setAccuracyTarget(int target)timesync responses are not set if the measured accuracy is less than the accuracyTarget.- Parameters:
target- accuracy target in ms
-
rcvMeta
Description copied from interface:BayeuxServer.ExtensionCallback method invoked every time a meta message is incoming.
- Specified by:
rcvMetain interfaceBayeuxServer.Extension- Overrides:
rcvMetain classBayeuxServer.Extension.Adapter- Parameters:
from- the session that sent the messagemessage- the incoming meta message- Returns:
- true if message processing should continue, false if it should stop
-
sendMeta
Description copied from interface:BayeuxServer.ExtensionCallback method invoked every time a meta message is outgoing.
- Specified by:
sendMetain interfaceBayeuxServer.Extension- Overrides:
sendMetain classBayeuxServer.Extension.Adapter- Parameters:
session- the session the message is sent to, or null for a publish.message- the outgoing meta message- Returns:
- true if message processing should continue, false if it should stop
-