org.matomo.sdk.dispatcher

Interface Dispatcher

All Known Implementing Classes:

DefaultDispatcher

public interface Dispatcher

Responsible for transmitting packets to a server

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_CONNECTION_TIMEOUT
static long	DEFAULT_DISPATCH_INTERVAL

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

Field Detail

DEFAULT_CONNECTION_TIMEOUT

static final int DEFAULT_CONNECTION_TIMEOUT

See Also:

Constant Field Values

DEFAULT_DISPATCH_INTERVAL

static final long DEFAULT_DISPATCH_INTERVAL

See Also:

Constant Field Values

Method Detail

getConnectionTimeOut

int getConnectionTimeOut()

Connection timeout in milliseconds

Returns:

timeout in milliseconds

setConnectionTimeOut

void setConnectionTimeOut(int timeOut)

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

Parameters:

timeOut - timeout in milliseconds

setDispatchInterval

void setDispatchInterval(long dispatchInterval)

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

Parameters:

dispatchInterval - in milliseconds

getDispatchInterval

long getDispatchInterval()

setDispatchGzipped

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

Parameters:

dispatchGzipped - boolean

getDispatchGzipped

boolean getDispatchGzipped()

setDispatchMode

void setDispatchMode(DispatchMode dispatchMode)

getDispatchMode

DispatchMode getDispatchMode()

forceDispatch

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.

forceDispatchBlocking

void forceDispatchBlocking()

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.

clear

void clear()

To clear the dispatchers queue

submit

void submit(TrackMe trackMe)

Submit for transmission

setDryRunTarget

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. Mind thread-safety!

getDryRunTarget

java.util.List<Packet> getDryRunTarget()

For debugging purposes Mind thread-safety!