Panda3D
Public Member Functions | Static Public Member Functions

SocketStreamRecorder Class Reference

Records any data received from the indicated socket stream. More...

Inheritance diagram for SocketStreamRecorder:
RecorderBase ReferenceCount MemoryBase

List of all members.

Public Member Functions

 SocketStreamRecorder ()
 SocketStreamRecorder (SocketStream stream, bool owns_stream)
 close ()
 See SocketStream.close().
bool considerFlush ()
 See SocketStream.consider_flush()
bool flush ()
 See SocketStream.flush()
bool getCollectTcp ()
 See SocketStream.get_collect_tcp().
double getCollectTcpInterval ()
 See SocketStream.get_collect_tcp_interval().
int getRefCount ()
 Returns the current reference count.
bool isClosed ()
 See SocketStream.is_closed().
bool isPlaying ()
 Returns true if this recorder is presently playing back data from session file, false otherwise.
bool isRecording ()
 Returns true if this recorder is presently recording data for saving to a session file, false otherwise.
bool receiveDatagram (Datagram dg)
 Receives a datagram over the socket by expecting a little-endian 16-bit byte count as a prefix.
 ref ()
 Explicitly increments the reference count.
bool sendDatagram (Datagram const dg)
 See SocketStream.send_datagram().
 setCollectTcp (bool collect_tcp)
 See SocketStream.set_collect_tcp().
 setCollectTcpInterval (double interval)
 See SocketStream.set_collect_tcp_interval().
bool testRefCountIntegrity ()
 Does some easy checks to make sure that the reference count isn't completely bogus.
bool testRefCountNonzero ()
 Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
bool unref ()
 Explicitly decrements the reference count.

Static Public Member Functions

static TypeHandle getClassType ()

Detailed Description

Records any data received from the indicated socket stream.

On playback, it will act as if the incoming data is coming over the wire again even if an actual connection is not available.

Outbound data will not be recorded, but will be sent straight through to the socket if it is connected, or silently ignored if it is not.


Constructor & Destructor Documentation

SocketStreamRecorder ( SocketStream  stream,
bool  owns_stream 
)

Member Function Documentation

close ( )
bool considerFlush ( )

See SocketStream.consider_flush()

bool flush ( )
static TypeHandle getClassType ( ) [static]

Reimplemented from RecorderBase.

bool getCollectTcp ( )

See SocketStream.get_collect_tcp().

double getCollectTcpInterval ( )

See SocketStream.get_collect_tcp_interval().

int getRefCount ( ) [inherited]

Returns the current reference count.

bool isClosed ( )

See SocketStream.is_closed().

bool isPlaying ( ) [inherited]

Returns true if this recorder is presently playing back data from session file, false otherwise.

If this is true, play_data() will be called from time to time.

bool isRecording ( ) [inherited]

Returns true if this recorder is presently recording data for saving to a session file, false otherwise.

If this is true, record_data() will be called from time to time.

bool receiveDatagram ( Datagram  dg)

Receives a datagram over the socket by expecting a little-endian 16-bit byte count as a prefix.

If the socket stream is non-blocking, may return false if the data is not available; otherwise, returns false only if the socket closes.

ref ( ) [inherited]

Explicitly increments the reference count.

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

bool sendDatagram ( Datagram const  dg)

See SocketStream.send_datagram().

setCollectTcp ( bool  collect_tcp)

See SocketStream.set_collect_tcp().

setCollectTcpInterval ( double  interval)

See SocketStream.set_collect_tcp_interval().

bool testRefCountIntegrity ( ) [inherited]

Does some easy checks to make sure that the reference count isn't completely bogus.

Returns true if ok, false otherwise.

Reimplemented in NodeReferenceCount, CachedTypedWritableReferenceCount, and NodeCachedReferenceCount.

bool testRefCountNonzero ( ) [inherited]

Does some easy checks to make sure that the reference count isn't zero, or completely bogus.

Returns true if ok, false otherwise.

bool unref ( ) [inherited]

Explicitly decrements the reference count.

Note that the object will not be implicitly deleted by unref() simply because the reference count drops to zero. (Having a member function delete itself is problematic.) However, see the helper function unref_delete().

User code should avoid using ref() and unref() directly, which can result in missed reference counts. Instead, let a PointerTo object manage the reference counting automatically.

This function is const, even though it changes the object, because generally fiddling with an object's reference count isn't considered part of fiddling with the object. An object might be const in other ways, but we still need to accurately count the number of references to it.

The return value is true if the new reference count is nonzero, false if it is zero.

Reimplemented in GeomVertexArrayFormat, and GeomVertexFormat.

 All Classes Namespaces Functions Variables Enumerations Enumerator Properties