gvisor.dev/gvisor@v0.0.0-20240520182842-f9d4d51c7e0f/test/util/pty_util.h (about)

     1  // Copyright 2019 The gVisor Authors.
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  #ifndef GVISOR_TEST_UTIL_PTY_UTIL_H_
    16  #define GVISOR_TEST_UTIL_PTY_UTIL_H_
    17  
    18  #include "test/util/file_descriptor.h"
    19  #include "test/util/posix_error.h"
    20  
    21  namespace gvisor {
    22  namespace testing {
    23  
    24  // Opens the replica end of the passed master as R/W and nonblocking. It does
    25  // not set the replica as the controlling TTY.
    26  PosixErrorOr<FileDescriptor> OpenReplica(const FileDescriptor& master);
    27  
    28  // Identical to the above OpenReplica, but flags are all specified by the
    29  // caller.
    30  PosixErrorOr<FileDescriptor> OpenReplica(const FileDescriptor& master,
    31                                           int flags);
    32  
    33  // Get the number of the replica end of the master.
    34  PosixErrorOr<int> ReplicaID(const FileDescriptor& master);
    35  
    36  }  // namespace testing
    37  }  // namespace gvisor
    38  
    39  #endif  // GVISOR_TEST_UTIL_PTY_UTIL_H_