X-Plane Remote Access Plugin and Client Library
Public Member Functions | Private Attributes | List of all members
xplra.Win32NamedPipe Class Reference
Inheritance diagram for xplra.Win32NamedPipe:

Public Member Functions

def __init__ (self, name)
 
def close (self)
 
def closed (self)
 
def fileno (self)
 
def flush (self)
 
def isatty (self)
 
def read (self, n=-1)
 
def readable (self)
 
def readall (self)
 
def readinto (self, buffer)
 
def readline (self, limit=-1)
 
def readlines (self, hint=-1)
 
def seek (self, offset, whence=io.SEEK_SET)
 
def seekable (self)
 
def tell (self)
 
def truncate (self, size=None)
 
def writable (self)
 
def write (self, buffer)
 
def writelines (self, lines)
 

Private Attributes

 _handle
 the Windows file handle for the pipe
 

Detailed Description

A stream object to represent a Win32 named pipe.

Definition at line 175 of file xplra.py.

Constructor & Destructor Documentation

◆ __init__()

def xplra.Win32NamedPipe.__init__ (   self,
  name 
)
Construct the pipe with the given name.

Definition at line 180 of file xplra.py.

Member Function Documentation

◆ close()

def xplra.Win32NamedPipe.close (   self)
Close the pipe, if not closed already.

Definition at line 188 of file xplra.py.

◆ closed()

def xplra.Win32NamedPipe.closed (   self)
Determine if the pipe is closed or not.

Definition at line 195 of file xplra.py.

◆ fileno()

def xplra.Win32NamedPipe.fileno (   self)
Get the file number, which is impossible.

Definition at line 199 of file xplra.py.

◆ flush()

def xplra.Win32NamedPipe.flush (   self)
Flush the stream.

Definition at line 203 of file xplra.py.

◆ isatty()

def xplra.Win32NamedPipe.isatty (   self)
Determine if the stream is a terminal, which it is not.

Definition at line 207 of file xplra.py.

◆ read()

def xplra.Win32NamedPipe.read (   self,
  n = -1 
)
Read at most the given number of bytes from the stream.

Definition at line 211 of file xplra.py.

◆ readable()

def xplra.Win32NamedPipe.readable (   self)
Determine if the stream is readable, which it is.

Definition at line 219 of file xplra.py.

◆ readall()

def xplra.Win32NamedPipe.readall (   self)
Read all bytes from the stream, which is not supported.

Definition at line 223 of file xplra.py.

◆ readinto()

def xplra.Win32NamedPipe.readinto (   self,
  buffer 
)
Read into the given buffer.

Definition at line 227 of file xplra.py.

◆ readline()

def xplra.Win32NamedPipe.readline (   self,
  limit = -1 
)
Read a line, which is currently not supported.

Definition at line 234 of file xplra.py.

◆ readlines()

def xplra.Win32NamedPipe.readlines (   self,
  hint = -1 
)
Read lines, which is currently not supported.

Definition at line 238 of file xplra.py.

◆ seek()

def xplra.Win32NamedPipe.seek (   self,
  offset,
  whence = io.SEEK_SET 
)
Seek in the stream, which is not supported.

Definition at line 242 of file xplra.py.

◆ seekable()

def xplra.Win32NamedPipe.seekable (   self)
Determine if the stream is seekable, which it is not.

Definition at line 246 of file xplra.py.

◆ tell()

def xplra.Win32NamedPipe.tell (   self)
Get the current position, which is not supported.

Definition at line 250 of file xplra.py.

◆ truncate()

def xplra.Win32NamedPipe.truncate (   self,
  size = None 
)
Truncate the stream, which is not supported.

Definition at line 254 of file xplra.py.

◆ writable()

def xplra.Win32NamedPipe.writable (   self)
Determine if the stream is writable, which it is.

Definition at line 258 of file xplra.py.

◆ write()

def xplra.Win32NamedPipe.write (   self,
  buffer 
)
Write the given buffer into the stream.

Definition at line 262 of file xplra.py.

◆ writelines()

def xplra.Win32NamedPipe.writelines (   self,
  lines 
)
Write the given lines, which is not supported.

Definition at line 267 of file xplra.py.


The documentation for this class was generated from the following file: