org.matomo.sdk.dispatcher

Class DefaultDispatcher

java.lang.Object

org.matomo.sdk.dispatcher.DefaultDispatcher

All Implemented Interfaces:

Dispatcher

public class DefaultDispatcher
extends java.lang.Object
implements Dispatcher

Responsible for transmitting packets to a server

Field Summary

Fields inherited from interface org.matomo.sdk.dispatcher.Dispatcher

DEFAULT_CONNECTION_TIMEOUT, DEFAULT_DISPATCH_INTERVAL

Constructor Summary

Constructors

Constructor and Description
DefaultDispatcher(EventCache eventCache, Connectivity connectivity, PacketFactory packetFactory, PacketSender packetSender)

Method Summary

Modifier and Type	Method and Description
void	clear() To clear the dispatchers queue
boolean	forceDispatch() Starts the dispatcher for one cycle if it is currently not working.
void	forceDispatchBlocking() Dispatch all events in the EventCache and return only after the dispatch is complete.
int	getConnectionTimeOut() Connection timeout in milliseconds
boolean	getDispatchGzipped()
long	getDispatchInterval()
DispatchMode	getDispatchMode()
java.util.List<Packet>	getDryRunTarget() For debugging purposes Mind thread-safety!
void	setConnectionTimeOut(int timeOut) Timeout when trying to establish connection and when trying to read a response.
void	setDispatchGzipped(boolean dispatchGzipped) Packets are collected and dispatched in batches.
void	setDispatchInterval(long dispatchInterval) Packets are collected and dispatched in batches, this intervals sets the pause between batches.
void	setDispatchMode(DispatchMode dispatchMode)
void	setDryRunTarget(java.util.List<Packet> dryRunTarget) For debugging purposes When this is non null then instead of sending data over the network it will be written into this list.
void	submit(TrackMe trackMe) Submit for transmission

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultDispatcher

public DefaultDispatcher(EventCache eventCache,
                         Connectivity connectivity,
                         PacketFactory packetFactory,
                         PacketSender packetSender)

Method Detail

getConnectionTimeOut

public int getConnectionTimeOut()

Connection timeout in milliseconds

Specified by:

getConnectionTimeOut in interface Dispatcher

Returns:

timeout in milliseconds

setConnectionTimeOut

public void setConnectionTimeOut(int timeOut)

Timeout when trying to establish connection and when trying to read a response. Values take effect on next dispatch.

Specified by:

setConnectionTimeOut in interface Dispatcher

Parameters:

timeOut - timeout in milliseconds

setDispatchInterval

public void setDispatchInterval(long dispatchInterval)

Packets are collected and dispatched in batches, this intervals sets the pause between batches.

Specified by:

setDispatchInterval in interface Dispatcher

Parameters:

dispatchInterval - in milliseconds

getDispatchInterval

public long getDispatchInterval()

Specified by:

getDispatchInterval in interface Dispatcher

setDispatchGzipped

public void setDispatchGzipped(boolean dispatchGzipped)

Packets are collected and dispatched in batches. This boolean sets if post must be gzipped or not. Use of gzip needs mod_deflate/Apache ou lua_zlib/NGINX

Specified by:

setDispatchGzipped in interface Dispatcher

Parameters:

dispatchGzipped - boolean

getDispatchGzipped

public boolean getDispatchGzipped()

Specified by:

getDispatchGzipped in interface Dispatcher

setDispatchMode

public void setDispatchMode(DispatchMode dispatchMode)

Specified by:

setDispatchMode in interface Dispatcher

getDispatchMode

public DispatchMode getDispatchMode()

Specified by:

getDispatchMode in interface Dispatcher

forceDispatch

public boolean forceDispatch()

Starts the dispatcher for one cycle if it is currently not working. If the dispatcher is working it will skip the dispatch interval once.

Specified by:

forceDispatch in interface Dispatcher

forceDispatchBlocking

public void forceDispatchBlocking()

Description copied from interface: Dispatcher

Dispatch all events in the EventCache and return only after the dispatch is complete. This method may be invoked while the Runtime is being torn down and should not start new threads.

Specified by:

forceDispatchBlocking in interface Dispatcher

clear

public void clear()

Description copied from interface: Dispatcher

To clear the dispatchers queue

Specified by:

clear in interface Dispatcher

submit

public void submit(TrackMe trackMe)

Description copied from interface: Dispatcher

Submit for transmission

Specified by:

submit in interface Dispatcher

setDryRunTarget

public void setDryRunTarget(java.util.List<Packet> dryRunTarget)

Description copied from interface: Dispatcher

For debugging purposes When this is non null then instead of sending data over the network it will be written into this list. Mind thread-safety!

Specified by:

setDryRunTarget in interface Dispatcher

getDryRunTarget

public java.util.List<Packet> getDryRunTarget()

Description copied from interface: Dispatcher

For debugging purposes Mind thread-safety!

Specified by:

getDryRunTarget in interface Dispatcher