Panda3D
|
Represents a single TCP or UDP socket for input or output. More...
#include "connection.h"
Public Member Functions | |
Connection (ConnectionManager *manager, Socket_IP *socket) | |
Creates a connection. | |
~Connection () | |
Closes a connection. | |
bool | consider_flush () |
Sends the most recently queued TCP datagram(s) if enough time has elapsed. | |
bool | flush () |
Sends the most recently queued TCP datagram(s) now. | |
NetAddress | get_address () const |
Returns the address bound to this connection, if it is a TCP connection. | |
bool | get_collect_tcp () const |
Returns the current setting of "collect-tcp" mode. | |
double | get_collect_tcp_interval () const |
Returns the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once. | |
ConnectionManager * | get_manager () const |
Returns a pointer to the ConnectionManager object that serves this connection. | |
int | get_ref_count () const |
Returns the current reference count. | |
Socket_IP * | get_socket () const |
Returns the internal Socket_IP that defines the connection. | |
WeakReferenceList * | get_weak_list () const |
Returns the WeakReferenceList associated with this ReferenceCount object. | |
bool | has_weak_list () const |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise. | |
void | local_object () |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack. | |
void | operator delete (void *ptr) |
void | operator delete (void *ptr, void *) |
void | operator delete[] (void *ptr) |
void | operator delete[] (void *, void *) |
void * | operator new (size_t size, void *ptr) |
void * | operator new (size_t size) |
void * | operator new[] (size_t size, void *ptr) |
void * | operator new[] (size_t size) |
void | ref () const |
Explicitly increments the reference count. | |
void | set_collect_tcp (bool collect_tcp) |
Enables or disables "collect-tcp" mode. | |
void | set_collect_tcp_interval (double interval) |
Specifies the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once. | |
void | set_ip_time_to_live (int ttl) |
Sets IP time-to-live. | |
void | set_ip_type_of_service (int tos) |
Sets IP type-of-service and precedence. | |
void | set_keep_alive (bool flag) |
Sets whether the connection is periodically tested to see if it is still alive. | |
void | set_linger (bool flag, double time) |
Sets the time to linger on close if data is present. | |
void | set_max_segment (int size) |
Sets the maximum segment size. | |
void | set_no_delay (bool flag) |
If flag is true, this disables the Nagle algorithm, and prevents delaying of send to coalesce packets. | |
void | set_recv_buffer_size (int size) |
Sets the size of the receive buffer, in bytes. | |
void | set_reuse_addr (bool flag) |
Sets whether local address reuse is allowed. | |
void | set_send_buffer_size (int size) |
Sets the size of the send buffer, in bytes. | |
bool | test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | test_ref_count_nonzero () const |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus. | |
virtual bool | unref () const |
Explicitly decrements the reference count. | |
void | weak_ref (WeakPointerToVoid *ptv) |
Adds the indicated PointerToVoid as a weak reference to this object. | |
void | weak_unref (WeakPointerToVoid *ptv) |
Removes the indicated PointerToVoid as a weak reference to this object. | |
Static Public Member Functions | |
static TypeHandle | get_class_type () |
static void | init_type () |
Protected Member Functions | |
bool | do_test_ref_count_integrity () const |
Does some easy checks to make sure that the reference count isn't completely bogus. | |
bool | do_test_ref_count_nonzero () const |
Returns true if the reference count is nonzero, false otherwise. | |
Friends | |
class | ConnectionWriter |
Represents a single TCP or UDP socket for input or output.
Definition at line 32 of file connection.h.
Connection::Connection | ( | ConnectionManager * | manager, |
Socket_IP * | socket | ||
) |
Creates a connection.
Normally this constructor should not be used directly by user code; use one of the methods in ConnectionManager to make a new connection.
Definition at line 40 of file connection.cxx.
References Socket_IP::SetNonBlocking().
Connection::~Connection | ( | ) |
Closes a connection.
Definition at line 65 of file connection.cxx.
References Socket_IP::Close(), and flush().
bool Connection::consider_flush | ( | ) |
Sends the most recently queued TCP datagram(s) if enough time has elapsed.
This only has meaning if set_collect_tcp() has been set to true.
Definition at line 184 of file connection.cxx.
References TrueClock::get_global_ptr().
bool ReferenceCount::do_test_ref_count_integrity | ( | ) | const [protected, 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.
Definition at line 29 of file referenceCount.cxx.
Referenced by ReferenceCount::do_test_ref_count_nonzero(), and ReferenceCount::test_ref_count_integrity().
bool ReferenceCount::do_test_ref_count_nonzero | ( | ) | const [protected, inherited] |
Returns true if the reference count is nonzero, false otherwise.
Definition at line 56 of file referenceCount.cxx.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by ReferenceCount::test_ref_count_nonzero().
bool Connection::flush | ( | void | ) |
Sends the most recently queued TCP datagram(s) now.
This only has meaning if set_collect_tcp() has been set to true.
Definition at line 211 of file connection.cxx.
Referenced by ConnectionManager::close_connection(), and ~Connection().
NetAddress Connection::get_address | ( | ) | const |
Returns the address bound to this connection, if it is a TCP connection.
Definition at line 84 of file connection.cxx.
References Socket_IP::GetPeerName().
bool Connection::get_collect_tcp | ( | ) | const |
Returns the current setting of "collect-tcp" mode.
See set_collect_tcp().
Definition at line 144 of file connection.cxx.
double Connection::get_collect_tcp_interval | ( | ) | const |
Returns the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once.
This only has meaning if "collect-tcp" mode is enabled; see set_collect_tcp().
Definition at line 172 of file connection.cxx.
ConnectionManager * Connection::get_manager | ( | ) | const |
Returns a pointer to the ConnectionManager object that serves this connection.
Definition at line 96 of file connection.cxx.
int ReferenceCount::get_ref_count | ( | ) | const [inline, inherited] |
Returns the current reference count.
Definition at line 155 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by TransformState::clear_cache(), RenderState::clear_cache(), RenderState::finalize(), RenderEffects::finalize(), RenderEffect::finalize(), RenderAttrib::finalize(), InternalName::finalize(), TransformState::get_num_unused_states(), RenderState::get_num_unused_states(), TransformState::list_cycles(), RenderState::list_cycles(), GeomVertexFormat::remove_column(), TransformState::unref(), RenderState::unref(), RenderState::~RenderState(), and TransformState::~TransformState().
Socket_IP * Connection::get_socket | ( | ) | const |
Returns the internal Socket_IP that defines the connection.
Definition at line 107 of file connection.cxx.
Referenced by ConnectionManager::close_connection(), ConnectionManager::flush_read_connection(), and ConnectionWriter::send().
WeakReferenceList * ReferenceCount::get_weak_list | ( | ) | const [inline, inherited] |
Returns the WeakReferenceList associated with this ReferenceCount object.
If there has never been a WeakReferenceList associated with this object, creates one now.
Definition at line 307 of file referenceCount.I.
Referenced by ReferenceCount::weak_ref().
bool ReferenceCount::has_weak_list | ( | ) | const [inline, inherited] |
Returns true if this particular ReferenceCount object has a WeakReferenceList created, false otherwise.
In general, this will be true if there was ever a WeakPointerTo created for this object (even if there is not any for it now).
Definition at line 294 of file referenceCount.I.
Referenced by ReferenceCount::weak_unref().
void ReferenceCount::local_object | ( | ) | [inline, inherited] |
This function should be called, once, immediately after creating a new instance of some ReferenceCount-derived object on the stack.
This allows the object to be passed to functions that will increment and decrement the object's reference count temporarily, and it will prevent the object from being deleted (inappropriately), when the reference count returns to zero. It actually achieves this by setting a large positive value in the reference count field.
Definition at line 276 of file referenceCount.I.
Referenced by PGTop::cull_callback(), BoundingSphere::extend_by_hexahedron(), AsyncTaskManager::find_task(), AsyncTaskManager::find_tasks(), and AsyncTaskManager::find_tasks_matching().
void ReferenceCount::ref | ( | ) | const [inline, 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.
Definition at line 179 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_ref(), TypedWritable::decode_raw_from_bam_stream(), NodeCachedReferenceCount::node_ref(), NodeReferenceCount::node_ref(), BamCacheRecord::set_data(), CullableObject::set_draw_callback(), and ModelRoot::set_reference().
void Connection::set_collect_tcp | ( | bool | collect_tcp | ) |
Enables or disables "collect-tcp" mode.
In this mode, individual TCP packets are not sent immediately, but rather they are collected together and accumulated to be sent periodically as one larger TCP packet. This cuts down on overhead from the TCP/IP protocol, especially if many small packets need to be sent on the same connection, but it introduces additional latency (since packets must be held before they can be sent).
See set_collect_tcp_interval() to specify the interval of time for which to hold packets before sending them.
If you enable this mode, you may also need to periodically call consider_flush() to flush the queue if no packets have been sent recently.
Definition at line 133 of file connection.cxx.
Referenced by PStatListener::connection_opened().
void Connection::set_collect_tcp_interval | ( | double | interval | ) |
Specifies the interval in time, in seconds, for which to hold TCP packets before sending all of the recently received packets at once.
This only has meaning if "collect-tcp" mode is enabled; see set_collect_tcp().
Definition at line 158 of file connection.cxx.
void Connection::set_ip_time_to_live | ( | int | ttl | ) |
Sets IP time-to-live.
Definition at line 311 of file connection.cxx.
void Connection::set_ip_type_of_service | ( | int | tos | ) |
Sets IP type-of-service and precedence.
Definition at line 321 of file connection.cxx.
void Connection::set_keep_alive | ( | bool | flag | ) |
Sets whether the connection is periodically tested to see if it is still alive.
Definition at line 278 of file connection.cxx.
*void Connection::set_linger | ( | bool | flag, |
double | time | ||
) |
Sets the time to linger on close if data is present.
If flag is false, when you close a socket with data available the system attempts to deliver the data to the peer (the default behavior). If flag is false but time is zero, the system discards any undelivered data when you close the socket. If flag is false but time is nonzero, the system waits up to time seconds to deliver the data.
Definition at line 250 of file connection.cxx.
References Socket_TCP::DontLinger(), and Socket_TCP::SetLinger().
void Connection::set_max_segment | ( | int | size | ) |
Sets the maximum segment size.
Definition at line 345 of file connection.cxx.
void Connection::set_no_delay | ( | bool | flag | ) |
If flag is true, this disables the Nagle algorithm, and prevents delaying of send to coalesce packets.
Definition at line 332 of file connection.cxx.
References Socket_TCP::SetNoDelay().
void Connection::set_recv_buffer_size | ( | int | size | ) |
Sets the size of the receive buffer, in bytes.
Definition at line 288 of file connection.cxx.
References Socket_IP::SetRecvBufferSize().
void Connection::set_reuse_addr | ( | bool | flag | ) |
Sets whether local address reuse is allowed.
Definition at line 267 of file connection.cxx.
References Socket_IP::SetReuseAddress().
void Connection::set_send_buffer_size | ( | int | size | ) |
Sets the size of the send buffer, in bytes.
Definition at line 298 of file connection.cxx.
References Socket_TCP::SetSendBufferSize().
bool ReferenceCount::test_ref_count_integrity | ( | ) | const [inline, 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.
Definition at line 236 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_integrity().
Referenced by EggGroupNode::add_child(), InternalName::find_ancestor(), InternalName::get_ancestor(), ReferenceCount::get_ref_count(), InternalName::get_top(), ReferenceCount::ref(), EggVertex::test_gref_integrity(), EggVertex::test_pref_integrity(), EggNode::test_under_integrity(), EggPrimitive::test_vref_integrity(), EggGroup::test_vref_integrity(), MouseWatcher::throw_event_pattern(), ReferenceCount::unref(), and EggNode::update_under().
bool ReferenceCount::test_ref_count_nonzero | ( | ) | const [inline, inherited] |
Does some easy checks to make sure that the reference count isn't zero, or completely bogus.
Returns true if ok, false otherwise.
Definition at line 252 of file referenceCount.I.
References ReferenceCount::do_test_ref_count_nonzero().
Referenced by CopyOnWritePointer::test_ref_count_nonzero().
bool ReferenceCount::unref | ( | ) | const [inline, virtual, 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, GeomVertexFormat, InternalName, RenderAttrib, RenderEffects, RenderState, and TransformState.
Definition at line 214 of file referenceCount.I.
References ReferenceCount::test_ref_count_integrity().
Referenced by CachedTypedWritableReferenceCount::cache_unref(), TypedWritable::decode_raw_from_bam_stream(), RenderEffect::finalize(), NodeCachedReferenceCount::node_unref(), NodeReferenceCount::node_unref(), TransformState::unref(), RenderState::unref(), RenderEffects::unref(), RenderAttrib::unref(), InternalName::unref(), GeomVertexFormat::unref(), and GeomVertexArrayFormat::unref().
void ReferenceCount::weak_ref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Adds the indicated PointerToVoid as a weak reference to this object.
Definition at line 321 of file referenceCount.I.
References WeakReferenceList::add_reference(), and ReferenceCount::get_weak_list().
void ReferenceCount::weak_unref | ( | WeakPointerToVoid * | ptv | ) | [inline, inherited] |
Removes the indicated PointerToVoid as a weak reference to this object.
It must have previously been added via a call to weak_ref().
Definition at line 334 of file referenceCount.I.
References WeakReferenceList::clear_reference(), and ReferenceCount::has_weak_list().