Class ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub

java.lang.Object
io.grpc.stub.AbstractStub<ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub>
io.grpc.stub.AbstractBlockingStub<ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub>
com.soulfiremc.grpc.generated.ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub
Enclosing class:
ProxyCheckServiceGrpc
public static final class ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub extends io.grpc.stub.AbstractBlockingStub<ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub>
A stub to allow clients to do synchronous rpc calls to service ProxyCheckService. 
Service for validating proxy servers by testing their ability to connect
to Minecraft servers. This is useful for filtering out dead or slow proxies
before using them for bot connections.
The service tests proxies by attempting to establish a Minecraft protocol
connection through each proxy to a configurable target server and waiting
for a status response packet. Results include whether the proxy works and
its latency.

  • Nested Class Summary

    Nested classes/interfaces inherited from class io.grpc.stub.AbstractStub

    io.grpc.stub.AbstractStub.StubFactory<T>

  • Method Summary

    Modifier and Type
    Method
    Description
    protected ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub
    build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
     
    io.grpc.stub.BlockingClientCall<?, ProxyCheckResponse>
    check(ProxyCheckRequest request)
    Checks the validity of one or more proxies by attempting to connect through them to a Minecraft server.

    Methods inherited from class io.grpc.stub.AbstractBlockingStub

    newStub, newStub

    Methods inherited from class io.grpc.stub.AbstractStub

    getCallOptions, getChannel, withCallCredentials, withChannel, withCompression, withDeadline, withDeadlineAfter, withDeadlineAfter, withExecutor, withInterceptors, withMaxInboundMessageSize, withMaxOutboundMessageSize, withOnReadyThreshold, withOption, withWaitForReady

    Methods inherited from class Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

  • Method Details

    • build

      protected ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub build(io.grpc.Channel channel, io.grpc.CallOptions callOptions)
      Specified by:
      build in class io.grpc.stub.AbstractStub<ProxyCheckServiceGrpc.ProxyCheckServiceBlockingV2Stub>

    • check

      @ExperimentalApi("https://github.com/grpc/grpc-java/issues/10918") public io.grpc.stub.BlockingClientCall<?, ProxyCheckResponse> check(ProxyCheckRequest request)
      Checks the validity of one or more proxies by attempting to connect
through them to a Minecraft server.
The check process:
1. For each proxy in the request, a connection attempt is made through
   the proxy to the Minecraft server configured in the instance settings
2. The connection uses the protocol version configured in the instance
3. A proxy is considered valid if it successfully connects and receives
   a server status response within 30 seconds
4. Results are streamed back as each check completes
5. A ProxyCheckEnd message is sent when all checks are complete
Concurrency is controlled by the instance's PROXY_CHECK_CONCURRENCY setting.
Required permission: CHECK_PROXY on the specified instance.
Error cases:
- NOT_FOUND: The specified instance_id does not exist
- PERMISSION_DENIED: The user lacks CHECK_PROXY permission on the instance
- INTERNAL: An unexpected error occurred during proxy checking
The stream can be cancelled by the client at any time, which will
terminate any in-progress proxy checks.