org.piwik.sdk.dispatcher

Class Dispatcher

java.lang.Object

org.piwik.sdk.dispatcher.Dispatcher

public class Dispatcher
extends java.lang.Object

Responsible for transmitting packets to a server

Constructor Summary

Constructors

Constructor and Description
Dispatcher(EventCache eventCache, Connectivity connectivity, PacketFactory packetFactory)

Method Summary

Modifier and Type	Method and Description
void	clear()
boolean	dispatch(Packet packet)
boolean	forceDispatch() Starts the dispatcher for one cycle if it is currently not working.
int	getConnectionTimeOut() Connection timeout in milliseconds
boolean	getDispatchGzipped()
long	getDispatchInterval()
DispatchMode	getDispatchMode()
java.util.List<Packet>	getDryRunTarget()
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)
void	submit(TrackMe trackMe)

Methods inherited from class java.lang.Object

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

Constructor Detail

Dispatcher

public Dispatcher(EventCache eventCache,
                  Connectivity connectivity,
                  PacketFactory packetFactory)

Method Detail

getConnectionTimeOut

public int getConnectionTimeOut()

Connection timeout in milliseconds

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.

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.

Parameters:

dispatchInterval - in milliseconds

getDispatchInterval

public long getDispatchInterval()

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

Parameters:

dispatchGzipped - boolean

getDispatchGzipped

public boolean getDispatchGzipped()

setDispatchMode

public void setDispatchMode(DispatchMode dispatchMode)

getDispatchMode

public DispatchMode getDispatchMode()

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.

clear

public void clear()

submit

public void submit(TrackMe trackMe)

dispatch

public boolean dispatch(@NonNull
                        Packet packet)
                 throws java.io.IOException

Parameters:

packet - to dispatch

Returns:

true if dispatch was successful

Throws:

java.io.IOException

setDryRunTarget

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

getDryRunTarget

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