Package crawlercommons.urlfrontier

Class URLFrontierGrpc.URLFrontierImplBase

  • All Implemented Interfaces:
    io.grpc.BindableService
    Enclosing class:
    URLFrontierGrpc
    public abstract static class URLFrontierGrpc.URLFrontierImplBase
extends Object
implements io.grpc.BindableService

    • Constructor Detail

      • URLFrontierImplBase

        public URLFrontierImplBase()

    • Method Detail

      • listNodes

        public void listNodes​(Urlfrontier.Empty request,
                      io.grpc.stub.StreamObserver<Urlfrontier.StringList> responseObserver)
         * Return the list of nodes forming the cluster the current node belongs to *

      • listCrawls

        public void listCrawls​(Urlfrontier.Local request,
                       io.grpc.stub.StreamObserver<Urlfrontier.StringList> responseObserver)
         * Return the list of crawls handled by the frontier(s) *

      • listQueues

        public void listQueues​(Urlfrontier.Pagination request,
                       io.grpc.stub.StreamObserver<Urlfrontier.QueueList> responseObserver)
         * Return a list of queues for a specific crawl. Can chose whether to include inactive queues (a queue is active if it has URLs due for fetching);
 by default the service will return up to 100 results from offset 0 and exclude inactive queues.*

      • getURLs

        public void getURLs​(Urlfrontier.GetParams request,
                    io.grpc.stub.StreamObserver<Urlfrontier.URLInfo> responseObserver)
         * Stream URLs due for fetching from M queues with up to N items per queue *

      • putURLs

        public io.grpc.stub.StreamObserver<Urlfrontier.URLItem> putURLs​(io.grpc.stub.StreamObserver<Urlfrontier.AckMessage> responseObserver)
         * Push URL items to the server; they get created (if they don't already exist) in case of DiscoveredURLItems or updated if KnownURLItems *

      • getStats

        public void getStats​(Urlfrontier.QueueWithinCrawlParams request,
                     io.grpc.stub.StreamObserver<Urlfrontier.Stats> responseObserver)
         * Return stats for a specific queue or an entire crawl. Does not aggregate the stats across different crawlids. *

      • blockQueueUntil

        public void blockQueueUntil​(Urlfrontier.BlockQueueParams request,
                            io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)
         * Block a queue from sending URLs; the argument is the number of seconds of UTC time since Unix epoch
 1970-01-01T00:00:00Z. The default value of 0 will unblock the queue. The block will get removed once the time
 indicated in argument is reached. This is useful for cases where a server returns a Retry-After for instance.

      • setActive

        public void setActive​(Urlfrontier.Active request,
                      io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)
         * De/activate the crawl. GetURLs will not return anything until SetActive is set to true. PutURLs will still take incoming data. *

      • getActive

        public void getActive​(Urlfrontier.Local request,
                      io.grpc.stub.StreamObserver<Urlfrontier.Boolean> responseObserver)
         * Returns true if the crawl is active, false if it has been deactivated with SetActive(Boolean) *

      • setDelay

        public void setDelay​(Urlfrontier.QueueDelayParams request,
                     io.grpc.stub.StreamObserver<Urlfrontier.Empty> responseObserver)
         * Set a delay from a given queue.
 No URLs will be obtained via GetURLs for this queue until the number of seconds specified has
 elapsed since the last time URLs were retrieved.
 Usually informed by the delay setting of robots.txt.

      • bindService

        public final io.grpc.ServerServiceDefinition bindService()
        Specified by:
        bindService in interface io.grpc.BindableService