io.jsync.streams.ReadSupport Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of jsync.io Show documentation

jsync.io is a non-blocking, event-driven networking framework for Java

There is a newer version: 1.10.13

/*
 * Copyright (c) 2011-2013 The original author or authors
 * ------------------------------------------------------
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * and Apache License v2.0 which accompanies this distribution.
 *
 *     The Eclipse Public License is available at
 *     http://www.eclipse.org/legal/epl-v10.html
 *
 *     The Apache License v2.0 is available at
 *     http://www.opensource.org/licenses/apache2.0.php
 *
 * You may elect to redistribute this code under either of these licenses.
 */
package io.jsync.streams;

import io.jsync.Handler;

/**
 * Allows to set a {@link Handler} which is notified once data was read.
 * It also allows to pause reading and resume later.
 *
 * @author Norman Maurer
 */
public interface ReadSupport extends ExceptionSupport {

    /**
     * Set a data handler. As data is read, the handler will be called with the data.
     */
    T dataHandler(Handler handler);

    /**
     * Pause the {@code ReadSupport}. While it's paused, no data will be sent to the {@code dataHandler}
     */
    T pause();

    /**
     * Resume reading. If the {@code ReadSupport} has been paused, reading will recommence on it.
     */
    T resume();
}