com.mongodb.internal.connection.tlschannel.NeedsWriteException Maven / Gradle / Ivy

/*
 * Copyright 2008-present MongoDB, Inc.
 *
 * 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.
 *
 * Original Work: MIT License, Copyright (c) [2015-2018] all contributors
 * https://github.com/marianobarrios/tls-channel
 */

package com.mongodb.internal.connection.tlschannel;

import java.nio.channels.ByteChannel;
import java.nio.channels.Selector;
import java.nio.channels.SocketChannel;

/**
 * This exception signals the caller that the operation cannot continue because
 * bytesProduced need to be write to the underlying {@link ByteChannel}, the channel is
 * non-blocking and there are no buffer space available. The caller should try
 * the operation again, either with the channel in blocking mode of after
 * ensuring that buffer space exists.
 * 
 * For {@link SocketChannel}s, a {@link Selector} can be used to find out when
 * the method should be retried.
 * 

 * Caveat: Any {@link TlsChannel} I/O method can throw this exception. In
 * particular, read may want to write data. This is because TLS
 * handshakes may occur at any time (initiated by either the client or the
 * server).
 * 
 * This exception is akin to the SSL_ERROR_WANT_WRITE error code used by
 * OpenSSL.
 *
 * @see 
 * OpenSSL error documentation
 */

public class NeedsWriteException extends WouldBlockException {

    private static final long serialVersionUID = -7789167281232559166L;
}