org.xlightweb.IEventDataSource Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of xlightweb-HTML5Preview

xLightweb HTML5 extension which supports ServerSentEvents ands WebSockets

The newest version!

/*
 *  Copyright (c) xlightweb.org, 2008 - 2010. All rights reserved.
 *
 *  This library is free software; you can redistribute it and/or
 *  modify it under the terms of the GNU Lesser General Public
 *  License as published by the Free Software Foundation; either
 *  version 2.1 of the License, or (at your option) any later version.
 *
 *  This library is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 *  Lesser General Public License for more details.
 *
 *  You should have received a copy of the GNU Lesser General Public
 *  License along with this library; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 * Please refer to the LGPL license at: http://www.gnu.org/copyleft/lesser.txt
 * The latest copy of this software may be found on http://www.xlightweb.org/
 */
package org.xlightweb;


import java.io.IOException;
import java.net.SocketTimeoutException;
import java.nio.channels.ClosedChannelException;





/**
 * WebEventEventDataSource
 * 
 * 

This is an experimental implementation of the HTML5 draft and subject to change
 * 
 * 
 * @author grro
 */
public interface IEventDataSource extends IReadableWebStream {

    int getReconnectionTimeMillis();
    
    void setReconnectionTimeMillis(int setReconnectionTimeMillis);
    
    String getLastEventId();
    
    int getNumReconnects();
    
    boolean isIgnoreCommentMessages();
    
    void setIgnoreCommentMessages(boolean isIgnoreCommentMessages);
    
    Event readMessage() throws IOException, ClosedChannelException;    
    
    Event readMessage(int readTimeoutMillis) throws IOException, SocketTimeoutException, ClosedChannelException;
}