alluxio.worker.package-info Maven / Gradle / Ivy
/*
* The Alluxio Open Foundation licenses this work under the Apache License, version 2.0
* (the "License"). You may not use this work except in compliance with the License, which is
* available at www.apache.org/licenses/LICENSE-2.0
*
* This software is distributed on an "AS IS" basis, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
* either express or implied, as more fully set forth in the License.
*
* See the NOTICE file distributed with this work for information regarding copyright ownership.
*/
/**
* Worker process and utils for working with the worker remotely.
*
* Main entry point for the worker is {@link alluxio.worker.AlluxioWorker#main}
* which gets started by the alluxio start scripts. The {@link alluxio.worker.WorkerProcess}
* spins up the different RPC services (gRPC, data) which are mostly wrappers around
* {@link alluxio.worker.block.BlockWorker}.
*
* Services
*
* DataServer
*
* This service is the main interaction between users and worker for reading and writing blocks.
* The {@link alluxio.worker.DataServer} interface defines how to start/stop, and get port
* details; to start, object init is used. The implementation of this interface is in
* {@link alluxio.worker.grpc.GrpcDataServer}. It creates an {@link alluxio.worker.DataServer}
* instance based on gRPC which is a high performance universal remote procedure call framework.
*
* Data server handles the following types of block requests:
*
* - Read blocks in worker storage from network
* - Read blocks in UFS
* - Write blocks in worker storage from network
* - Write blocks in worker storage from local file system:
* short-circuit write for local client
* - Write blocks in UFS
*
*
* The current protocol is described in {@link alluxio.proto.dataserver.Protocol}.
* All the requests are generated by Protobuf to keep the protocol extensible but also
* backward-compatible.
*
*/
package alluxio.worker;