eric4.DebugClients.Ruby.AsyncFile

File implementing an asynchronous file like socket interface for the debugger.

Global Attributes

None

Classes

AsyncFile

Class wrapping a socket object with a file interface.

Modules

None

Functions

<<	Synonym for write(s).
AsyncPendingWrite	Module function to check for data to be written.
close	Public method to close the file.
fileno	Public method returning the file number.
flush	Public method to write all pending bytes.
getSock	Public method to get the socket object.
isatty	Public method to indicate whether a tty interface is supported.
pendingWrite	Public method that returns the number of bytes waiting to be written.
read	Public method to read bytes from this file.
readline	Public method to read a line from this file.
readlines	Public method to read all lines from this file.
seek	Public method to move the filepointer.
tell	Public method to get the filepointer position.
write	Public method to write a string to the file.
writelines	Public method to write a list of strings to the file.

AsyncFile

Class wrapping a socket object with a file interface.

Derived from

None

Class Attributes

@@maxbuffersize

@@maxtries

Class Methods

None

Methods

checkMode	Private method to check the mode.
initialize	Constructor
nWrite	Private method to write a specific number of pending bytes.

Static Methods

None

AsyncFile.checkMode

checkMode()

Private method to check the mode.

This method checks, if an operation is permitted according to the mode of the file. If it is not, an IOError is raised.

mode: the mode to be checked (string)

AsyncFile.initialize

initialize(mode, name)

Constructor

sock: the socket object being wrapped
mode: mode of this file (string)
name: name of this file (string)

AsyncFile.nWrite

nWrite()

Private method to write a specific number of pending bytes.

n: the number of bytes to be written (int)

<<

<<(s)

Synonym for write(s).

s: bytes to be written (string)

AsyncPendingWrite

AsyncPendingWrite(file)

Module function to check for data to be written.

file: The file object to be checked (file)

Returns:: Flag indicating if there is data wating (int)

close

close()

Public method to close the file.

fileno

fileno()

Public method returning the file number.

Returns:: file number (int)

flush

flush()

Public method to write all pending bytes.

getSock

getSock()

Public method to get the socket object.

Returns:: the socket object

isatty

isatty()

Public method to indicate whether a tty interface is supported.

Returns:: always false

pendingWrite

pendingWrite()

Public method that returns the number of bytes waiting to be written.

Returns:: the number of bytes to be written (int)

read

read(size = -1)

Public method to read bytes from this file.

size: maximum number of bytes to be read (int)

Returns:: the bytes read (any)

readline

readline(size = -1)

Public method to read a line from this file.

Note: This method will not block and may return only a part of a line if that is all that is available.

size: maximum number of bytes to be read (int)

Returns:: one line of text up to size bytes (string)

readlines

readlines(sizehint = -1)

Public method to read all lines from this file.

sizehint: hint of the numbers of bytes to be read (int)

Returns:: list of lines read (list of strings)

seek

seek(offset, whence=IO::SEEK_SET)

Public method to move the filepointer.

Raises IOError:: This method is not supported and always raises an IOError.

tell

tell()

Public method to get the filepointer position.

Raises IOError:: This method is not supported and always raises an IOError.

write

write(s)

Public method to write a string to the file.

s: bytes to be written (string)

writelines

writelines(list)

Public method to write a list of strings to the file.

list: the list to be written (list of string)