panda3d.core.DatagramSink

from panda3d.core import DatagramSink
class DatagramSink

This class defines the abstract interface to sending datagrams to any target, whether it be into a file or across the net

Inheritance diagram

Inheritance diagram of DatagramSink

putDatagram(data: Datagram) → bool
copyDatagram(result: SubfileInfo, filename: Filename) → bool

Copies the file data from the entire indicated file (via the vfs) as the next datagram. This is intended to support potentially very large datagrams.

Returns true on success, false on failure or if this method is unimplemented. On true, fills “result” with the information that references the copied file, if possible.

copyDatagram(result: SubfileInfo, source: SubfileInfo) → bool

Copies the file data from the range of the indicated file (outside of the vfs) as the next datagram. This is intended to support potentially very large datagrams.

Returns true on success, false on failure or if this method is unimplemented. On true, fills “result” with the information that references the copied file, if possible.

isError() → bool
flush() → None
getFilename() → Filename

Returns the filename that provides the target for these datagrams, if any, or empty string if the datagrams do not get written to a file on disk.

Return type

Filename

getFile() → FileReference

Returns the FileReference that provides the target for these datagrams, if any, or NULL if the datagrams do not written to a file on disk.

Return type

FileReference

getFilePos() → streamoff

Returns the current file position within the data stream, if any, or 0 if the file position is not meaningful or cannot be determined.

For DatagramSinks that return a meaningful file position, this will be pointing to the first byte following the datagram returned after a call to putDatagram().

Return type

streamoff

property filename

Returns the filename that provides the target for these datagrams, if any, or empty string if the datagrams do not get written to a file on disk.

Return type

Filename

property file

Returns the FileReference that provides the target for these datagrams, if any, or NULL if the datagrams do not written to a file on disk.

Return type

FileReference

property file_pos

Returns the current file position within the data stream, if any, or 0 if the file position is not meaningful or cannot be determined.

For DatagramSinks that return a meaningful file position, this will be pointing to the first byte following the datagram returned after a call to putDatagram().

Return type

streamoff