org.springframework.messaging.tcp.reactor.ReactorNettyCodec Maven / Gradle / Ivy
/*
* Copyright 2002-2018 the original author or authors.
*
* 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
*
* https://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 org.springframework.messaging.tcp.reactor;
import java.util.Collection;
import java.util.function.BiConsumer;
import java.util.function.Function;
import io.netty.buffer.ByteBuf;
import org.springframework.messaging.Message;
/**
* Simple holder for a decoding {@link Function} and an encoding
* {@link BiConsumer} to use with Reactor Netty.
*
* @author Rossen Stoyanchev
* @since 5.0
* @param the message payload type
*/
public interface ReactorNettyCodec
{
/**
* Decode the input {@link ByteBuf} into one or more {@link Message Messages}.
* @param inputBuffer the input buffer to decode from
* @return 0 or more decoded messages
*/
Collection> decode(ByteBuf inputBuffer);
/**
* Encode the given {@link Message} to the output {@link ByteBuf}.
* @param message the message to encode
* @param outputBuffer the buffer to write to
*/
void encode(Message message, ByteBuf outputBuffer);
}