io.pkts.streams.impl

Class SimpleCallStateMachine

java.lang.Object

io.pkts.streams.impl.SimpleCallStateMachine

public final class SimpleCallStateMachine
extends Object

A "state machine" for SIP but really mainly for SIP VoIP calls. The reason for the quotes around state machine is that it is really not a true state machine for various reasons, one of which is that it allows events to be re-ordered since if multiple pcaps are merged you may actually push a pcap that was captured later first and as such we need to be able to handle this use case. Also, this state machine is simplified and will for some use cases report the wrong state. However, the purpose of this state machine is (currently anyway) not to be 100% accurate but close enough to be useful and fast.

Author:

jonas@jonasborjesson.com

Constructor Summary

Constructors

Constructor and Description
SimpleCallStateMachine(String callId)

Method Summary

Modifier and Type	Method and Description
SipStream.CallState	getCallState() The current state of this state machine, same as getting the last element in getTransitions()
long	getDuration()
List<SipPacket>	getMessages() Get all the messages that this fsm has seen so far.
long	getPostDialDelay()
long	getTimeOfFirstMessage() The time of the very first message.
long	getTimeOfLastMessage() Get the time of the very last message that we have seen so far.
List<SipStream.CallState>	getTransitions() Get a list of all the transitions this state machine took.
boolean	isHandshakeCompleted()
boolean	isTerminated() Check whether the state of this SimpleCallStateMachine is considered to be terminated.
void	onEvent(SipPacket msg) At some point we may want to have a generic event but for now this will only be SipPackets.
boolean	reTransmitsDetected()

Methods inherited from class java.lang.Object

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

Constructor Detail

SimpleCallStateMachine

public SimpleCallStateMachine(String callId)

Method Detail

getTimeOfFirstMessage

public long getTimeOfFirstMessage()

The time of the very first message.

Returns:

the arrival time of the first message seen so far or -1 (negative one) in case we haven't seen any messages yet.

getTimeOfLastMessage

public long getTimeOfLastMessage()

Get the time of the very last message that we have seen so far.

Returns:

the arrival time of the last message seen so far or -1 (negative one) in case we haven't seen any messages yet.

isHandshakeCompleted

public boolean isHandshakeCompleted()

reTransmitsDetected

public boolean reTransmitsDetected()

onEvent

public void onEvent(SipPacket msg)
             throws SipPacketParseException

At some point we may want to have a generic event but for now this will only be SipPackets. Note, if the SipPacket arrived earlier than the oldest element that this SimpleCallStateMachine has seen before then this new SipPacket will be inserted in the time sequence and then all the events will be "re-played".

Parameters:

msg -

Throws:

SipPacketParseException

isTerminated

public boolean isTerminated()

Check whether the state of this SimpleCallStateMachine is considered to be terminated.

Returns:

getMessages

public List<SipPacket> getMessages()

Get all the messages that this fsm has seen so far.

Returns:

getTransitions

public List<SipStream.CallState> getTransitions()

Get a list of all the transitions this state machine took.

Returns:

getCallState

public SipStream.CallState getCallState()

The current state of this state machine, same as getting the last element in getTransitions()

Returns:

getPostDialDelay

public long getPostDialDelay()
                      throws SipPacketParseException

Throws:

SipPacketParseException

getDuration

public long getDuration()