/*
 * This software is distributed under following license based on modified BSD
 * style license.
 * ----------------------------------------------------------------------
 * 
 * Copyright 2009 The Nimbus2 Project. All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 * 
 * 1. Redistributions of source code must retain the above copyright notice,
 *    this list of conditions and the following disclaimer. 
 * 2. Redistributions in binary form must reproduce the above copyright notice,
 *    this list of conditions and the following disclaimer in the documentation
 *    and/or other materials provided with the distribution.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE NIMBUS PROJECT ``AS IS'' AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN
 * NO EVENT SHALL THE NIMBUS PROJECT OR CONTRIBUTORS BE LIABLE FOR ANY
 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
 * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 * 
 * The views and conclusions contained in the software and documentation are
 * those of the authors and should not be interpreted as representing official
 * policies, either expressed or implied, of the Nimbus2 Project.
 */
package jp.ossc.nimbus.service.websocket.jetty;

import jp.ossc.nimbus.core.ServiceBaseMBean;

/**
 * {@link DefaultPingSenderService}のMBeanインタフェース。<p>
 * 
 * @author M.Takata
 */
public interface DefaultPingSenderServiceMBean extends ServiceBaseMBean{
    
    /**
     * PINGの送信間隔[ms]を設定する。<p>
     * デフォルトは、30秒。<br>
     *
     * @param interval PINGの送信間隔[ms]
     */
    public void setPingInterval(long interval);
    
    /**
     * PINGの送信間隔[ms]を取得する。<p>
     *
     * @return PINGの送信間隔[ms]
     */
    public long getPingInterval();
    
    /**
     * PINGの応答がない場合に、リトライする回数を設定する。<p>
     * デフォルトは、0でリトライしない。<br>
     *
     * @param max リトライする回数
     */
    public void setMaxRetryCount(int max);
    
    /**
     * PINGの応答がない場合に、リトライする回数を取得する。<p>
     *
     * @return リトライする回数
     */
    public int getMaxRetryCount();
    
    /**
     * PINGの応答がない場合の、終了コードを設定する。<p>
     * デフォルトは、1000。<br>
     *
     * @param code 終了コード
     */
    public void setCloseCodeForNoPong(int code);
    
    /**
     * PINGの応答がない場合の、終了コードを取得する。<p>
     *
     * @return 終了コード
     */
    public int getCloseCodeForNoPong();
    
    /**
     * PINGの応答をしないクライアントを許容するかどかを設定する。<p>
     * デフォルトは、falseで、許容しない。<br>
     *
     * @param isAllow 許容する場合は、true
     */
    public void setAllowNoPong(boolean isAllow);
    
    /**
     * PINGの応答をしないクライアントを許容するかどかを取得する。<p>
     *
     * @return trueの場合は、許容する
     */
    public boolean isAllowNoPong();
}
