org.littleshoot.stun.stack.transaction.StunClientTransaction Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of stun-stack Show documentation

The newest version!

package org.littleshoot.stun.stack.transaction;

import java.net.InetSocketAddress;

import org.littleshoot.stun.stack.message.StunMessage;
import org.littleshoot.stun.stack.message.StunMessageVisitor;

/**
 * Interface for client transactions.
 * 
 * @param  The visitor return type.
 */
public interface StunClientTransaction extends StunMessageVisitor
    {

    /**
     * Accessor for the request that started the transaction.
     * 
     * @return The request that started the transaction.
     */
    StunMessage getRequest();
    
    /**
     * Accessor for the total transaction time for the transaction.
     * 
     * @return The total time the transaction took.
     */
    long getTransactionTime();

    /**
     * Adds a listener to the transaction.  This should typically be called 
     * before any message has been sent -- before the transaction has started 
     * -- to ensure events aren't missed.
     * 
     * @param listener The listener to add.
     */
    void addListener(StunTransactionListener listener);

    /**
     * Gets the destination host the transaction was intended for.  This 
     * allows handlers to verify that the source of incoming packets is the
     * source we expect.
     * 
     * @return The intended destination host.
     */
    InetSocketAddress getIntendedDestination();

    }