SocketStreamRecorder

Inheritance:

Methods of SocketStreamRecorder:

Methods of RecorderBase:

Methods of ReferenceCount:

SocketStreamRecorder
SocketStreamRecorder::SocketStreamRecorder(void);

Description:

close
void SocketStreamRecorder::close(void);

Description: See SocketStream::close().

considerFlush
bool SocketStreamRecorder::consider_flush(void);

Description: See SocketStream::consider_flush()

flush
bool SocketStreamRecorder::flush(void);

Description: See SocketStream::flush()

getClassType
static TypeHandle SocketStreamRecorder::get_class_type(void);

Undocumented function.

getCollectTcp
bool SocketStreamRecorder::get_collect_tcp(void) const;

Description: See SocketStream::get_collect_tcp().

getCollectTcpInterval
double SocketStreamRecorder::get_collect_tcp_interval(void) const;

Description: See SocketStream::get_collect_tcp_interval().

isClosed
bool SocketStreamRecorder::is_closed(void);

Description: See SocketStream::is_closed().

receiveDatagram
bool SocketStreamRecorder::receive_datagram(Datagram &dg);

Description: 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.

sendDatagram
bool SocketStreamRecorder::send_datagram(Datagram const &dg);

Description: See SocketStream::send_datagram().

setCollectTcp
void SocketStreamRecorder::set_collect_tcp(bool collect_tcp);

Description: See SocketStream::set_collect_tcp().

setCollectTcpInterval
void SocketStreamRecorder::set_collect_tcp_interval(double interval);

Description: See SocketStream::set_collect_tcp_interval().

getClassType
static TypeHandle RecorderBase::get_class_type(void);

Undocumented function.

isPlaying
bool RecorderBase::is_playing(void) const;

Description: 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.

isRecording
bool RecorderBase::is_recording(void) const;

Description: 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.

getClassType
static TypeHandle ReferenceCount::get_class_type(void);

Undocumented function.

getRefCount
int ReferenceCount::get_ref_count(void) const;

Description: Returns the current reference count.

ref
void ReferenceCount::ref(void) const;

Description: 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.

testRefCountIntegrity
bool ReferenceCount::test_ref_count_integrity(void) const;

Description: Does some easy checks to make sure that the reference count isn't completely bogus. Returns true if ok, false otherwise.

testRefCountNonzero
bool ReferenceCount::test_ref_count_nonzero(void) const;

Description: Does some easy checks to make sure that the reference count isn't zero, or completely bogus. Returns true if ok, false otherwise.

unref
bool ReferenceCount::unref(void) const;

Description: 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; plus, we don't have a virtual destructor anyway.) 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.