reactor.ipc.stream.StreamConnector 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.stream;

import java.util.Objects;
import java.util.function.BiConsumer;
import java.util.function.Function;
import java.util.function.Supplier;

import reactor.core.Disposable;
import reactor.core.publisher.Mono;
import reactor.ipc.connector.Connector;
import reactor.ipc.connector.Inbound;
import reactor.ipc.connector.Outbound;

/**
 * A stream connector is {@link Connector} supporting reactive streams semantics.
 *
 * @param  the input connection data type (bytes, object...)
 * @param  the output connection data type (bytes, object...)
 * @param  incoming traffic API such as server request or client response
 * @param  outgoing traffic API such as server response or client request
 */
public interface StreamConnector, OUTBOUND extends Outbound>
		extends Connector {

	/**
	 *
	 * @param connector
	 * @param decoder
	 * @param encoder
	 * @param 
	 * @param 
	 * @param 
	 * @param 
	 * @return a {@link StreamConnector}
	 */
	static , OUTBOUND extends Outbound> StreamConnector from(
			Connector connector,
			BiConsumer decoder,
			Function encoder) {
		return new SimpleStreamConnector<>(connector, decoder, encoder);
	}

	/**
	 * @param receiverSupplier
	 *
	 * @return
	 */
	default Mono newReceiver(Supplier receiverSupplier) {
		Objects.requireNonNull(receiverSupplier, "receiver");
		return newBidirectional(receiverSupplier, null);
	}

	/**
	 * @param api
	 * @param 
	 *
	 * @return
	 */
	default  Mono newProducer(Class api) {
		Objects.requireNonNull(api, "api");
		return newBidirectional(null, api);
	}

	/**
	 * @param receiverSupplier
	 * @param api
	 * @param 
	 *
	 * @return
	 */
	 Mono newBidirectional(Supplier receiverSupplier,
			Class api);
	/**
	 * @param receiverSupplier
	 * @param api
	 * @param decoder
	 * @param encoder
	 * @param 
	 *
	 * @return
	 */
	default  Mono newStreamSupport(Supplier receiverSupplier,
			Class api,
			BiConsumer decoder,
			Function encoder) {
		return StreamSetup.connect(this, receiverSupplier, api, decoder, encoder);
	}

}