com.facebook.buck.remoteexecution.interfaces

Interface Protocol

All Known Implementing Classes:

GrpcProtocol

public interface Protocol

The Protocol interface is used by many parts of isolated/remote execution and abstracts away the underlying serialization protocol and in-memory representation.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	Protocol.Action An action to execute remotely
static interface	Protocol.Command A command line and environment variables.
static interface	Protocol.Digest A content digest.
static interface	Protocol.Directory A Directory consists of a list of files and child DirectoryNodes.
static interface	Protocol.DirectoryNode Represents a child of a Directory.
static interface	Protocol.FileNode Represents a possibly executable file in directories/trees.
static interface	Protocol.OutputDirectory An OutputDirectory is a merkle tree rooted at a particular path.
static interface	Protocol.OutputFile An OutputFile is like a FileNode for action outputs.
static interface	Protocol.SymlinkNode Representation of a symlink.
static interface	Protocol.Tree A Tree contains all Directories in a merkle tree in a single structure.
static interface	Protocol.TreeNode Represents a tree node

Method Summary

Modifier and Type	Method and Description
Protocol.Digest	computeDigest(byte[] data)
Protocol.Digest	computeDigest(Protocol.Directory directory)
com.google.common.hash.HashFunction	getHashFunction()
MessageDigest	getMessageDigest()
Protocol.Action	newAction(Protocol.Digest commandDigest, Protocol.Digest inputRootDigest)
Protocol.Command	newCommand(com.google.common.collect.ImmutableList<String> command, com.google.common.collect.ImmutableSortedMap<String,String> commandEnvironment, Set<Path> outputs, com.facebook.buck.remoteexecution.proto.WorkerRequirements workerRequirements)
Protocol.Digest	newDigest(String hash, int size)
Protocol.Directory	newDirectory(List<Protocol.DirectoryNode> directories, Collection<Protocol.FileNode> files, Collection<Protocol.SymlinkNode> symlinks)
Protocol.DirectoryNode	newDirectoryNode(String name, Protocol.Digest child)
Protocol.FileNode	newFileNode(Protocol.Digest digest, String name, boolean isExecutable)
Protocol.OutputDirectory	newOutputDirectory(Path output, Protocol.Digest treeDigest)
Protocol.OutputFile	newOutputFile(Path output, Protocol.Digest digest, boolean isExecutable)
Protocol.SymlinkNode	newSymlinkNode(String name, Path path)
Protocol.Tree	newTree(Protocol.Directory directory, List<Protocol.Directory> directories)
Protocol.Action	parseAction(ByteBuffer data)
Protocol.Command	parseCommand(ByteBuffer data)
Protocol.Directory	parseDirectory(ByteBuffer data)
Protocol.Tree	parseTree(ByteBuffer data)
byte[]	toByteArray(Protocol.Action action)
byte[]	toByteArray(Protocol.Command actionCommand)
byte[]	toByteArray(Protocol.Directory directory)
byte[]	toByteArray(Protocol.Tree tree)

Method Detail

newCommand

Protocol.Command newCommand(com.google.common.collect.ImmutableList<String> command,
                            com.google.common.collect.ImmutableSortedMap<String,String> commandEnvironment,
                            Set<Path> outputs,
                            com.facebook.buck.remoteexecution.proto.WorkerRequirements workerRequirements)

newAction

Protocol.Action newAction(Protocol.Digest commandDigest,
                          Protocol.Digest inputRootDigest)

newOutputDirectory

Protocol.OutputDirectory newOutputDirectory(Path output,
                                            Protocol.Digest treeDigest)

newTree

Protocol.Tree newTree(Protocol.Directory directory,
                      List<Protocol.Directory> directories)

newDigest

Protocol.Digest newDigest(String hash,
                          int size)

newOutputFile

Protocol.OutputFile newOutputFile(Path output,
                                  Protocol.Digest digest,
                                  boolean isExecutable)

newFileNode

Protocol.FileNode newFileNode(Protocol.Digest digest,
                              String name,
                              boolean isExecutable)

newSymlinkNode

Protocol.SymlinkNode newSymlinkNode(String name,
                                    Path path)

parseCommand

Protocol.Command parseCommand(ByteBuffer data)
                       throws IOException

Throws:

IOException

parseAction

Protocol.Action parseAction(ByteBuffer data)
                     throws IOException

Throws:

IOException

parseDirectory

Protocol.Directory parseDirectory(ByteBuffer data)
                           throws IOException

Throws:

IOException

parseTree

Protocol.Tree parseTree(ByteBuffer data)
                 throws IOException

Throws:

IOException

newDirectoryNode

Protocol.DirectoryNode newDirectoryNode(String name,
                                        Protocol.Digest child)

newDirectory

Protocol.Directory newDirectory(List<Protocol.DirectoryNode> directories,
                                Collection<Protocol.FileNode> files,
                                Collection<Protocol.SymlinkNode> symlinks)

toByteArray

byte[] toByteArray(Protocol.Directory directory)

toByteArray

byte[] toByteArray(Protocol.Tree tree)

toByteArray

byte[] toByteArray(Protocol.Command actionCommand)

toByteArray

byte[] toByteArray(Protocol.Action action)

computeDigest

Protocol.Digest computeDigest(Protocol.Directory directory)

computeDigest

Protocol.Digest computeDigest(byte[] data)

getHashFunction

com.google.common.hash.HashFunction getHashFunction()

getMessageDigest

MessageDigest getMessageDigest()