reactor.ipc.connector.Inbound Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of reactor-ipc Show documentation

IPC contracts for Reactive transport and protocol

The newest version!

/*
 * Copyright (c) 2011-2016 Pivotal Software Inc, All Rights Reserved.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *       http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package reactor.ipc.connector;

import reactor.core.publisher.Flux;

/**
 * A {@link Inbound} is a reactive gateway for incoming data flows.
 * Implementations handle interacting inbound (received data) and errors by subscribing to {@link #receive()}.
 * 
 *
 * @author Stephane Maldini
 * @since 0.6
 */
@FunctionalInterface
public interface Inbound  {

	/**
	 * Get the inbound publisher (incoming tcp traffic for instance)
	 *
	 * @return A {@link Flux} to signal reads and stop reading when un-requested.
	 */
	Flux receive();
}