io.inverno.mod.http.server.internal.http1x.Http1xConnectionEncoder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of inverno-http-server Show documentation

Inverno HTTP 1.x/2 server module

There is a newer version: 1.11.0

/*
 * Copyright 2020 Jeremy KUHN
 *
 * 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 io.inverno.mod.http.server.internal.http1x;

import io.netty.channel.ChannelFuture;
import io.netty.channel.ChannelHandlerContext;
import io.netty.channel.ChannelPromise;

/**
 * 
 * A HTTP1.x connection encoder used to write data frame to the client.
 * 
 * 
 * @author Jeremy Kuhn
 * @since 1.0
 */
interface Http1xConnectionEncoder {

	/**
	 * 
	 * Writes the specified message to the specified channel handler context.
	 * 
	 * 
	 * @param ctx     the channel handler context
	 * @param msg     the message to write
	 * @param promise the write promise
	 * 
	 * @return a channel future
	 */
	ChannelFuture writeFrame(ChannelHandlerContext ctx, Object msg, ChannelPromise promise);
}