io.grpc.okhttp.HandshakerSocketFactory Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of grpc-okhttp Show documentation

gRPC: OkHttp

The newest version!

/*
 * Copyright 2022 The gRPC 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
 *
 *     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.grpc.okhttp;

import com.google.common.base.Preconditions;
import io.grpc.Attributes;
import io.grpc.InternalChannelz;
import java.io.IOException;
import java.net.Socket;

/** Handshakes new connections. */
interface HandshakerSocketFactory {
  /** When the returned socket is closed, {@code socket} must be closed. */
  HandshakeResult handshake(Socket socket, Attributes attributes) throws IOException;

  static final class HandshakeResult {
    public final Socket socket;
    public final Attributes attributes;
    public final InternalChannelz.Security securityInfo;

    public HandshakeResult(
        Socket socket, Attributes attributes, InternalChannelz.Security securityInfo) {
      this.socket = Preconditions.checkNotNull(socket, "socket");
      this.attributes = Preconditions.checkNotNull(attributes, "attributes");
      this.securityInfo = securityInfo;
    }
  }
}