CConnectionRepository

class CConnectionRepository

This class implements the C++ side of the ConnectionRepository object. In particular, it manages the connection to the server once it has been opened (but does not open it directly). It manages reading and writing datagrams on the connection and monitoring for unexpected disconnects as well as handling intentional disconnects.

Certain server messages, like field updates, are handled entirely within the C++ layer, while server messages that are not understood by the C++ layer are returned up to the Python layer for processing.

Inheritance diagram

Inheritance diagram of CConnectionRepository

explicit CConnectionRepository(bool has_owner_view = false, bool threaded_net = false)
void abandon_message_bundles(void)

throw out any msgs that have been queued up for message bundles

void bundle_msg(Datagram const &dg)
bool check_datagram(void)

Returns true if a new datagram is available, false otherwise. If the return value is true, the new datagram may be retrieved via get_datagram(), or preferably, with get_datagram_iterator() and get_msg_type().

bool connect_native(URLSpec const &url)

Connects to the server using Panda’s low-level and fast “native net” library.

bool consider_flush(void)

Sends the most recently queued data if enough time has elapsed. This only has meaning if set_collect_tcp() has been set to true.

void disconnect(void)

Closes the connection to the server.

bool flush(void)

Sends the most recently queued data now. This only has meaning if set_collect_tcp() has been set to true.

Buffered_DatagramConnection &get_bdc(void)

Returns the Buffered_DatagramConnection object associated with the repository.

bool get_client_datagram(void) const

Returns the client_datagram flag.

ConnectionWriter &get_cw(void)

Returns the ConnectionWriter object associated with the repository.

void get_datagram(Datagram &dg)

Fills the datagram object with the datagram most recently retrieved by check_datagram().

void get_datagram_iterator(DatagramIterator &di)

Fills the DatagramIterator object with the iterator for the datagram most recently retrieved by check_datagram(). This iterator has already read past the datagram header and the message type, and is positioned at the beginning of data.

DCFile &get_dc_file(void)

Returns the DCFile object associated with this repository.

bool get_handle_c_updates(void) const

Returns true if this repository will process distributed updates internally in C++ code, or false if it will return them to Python.

bool get_handle_datagrams_internally(void) const

Returns the handle_datagrams_internally flag.

bool get_in_quiet_zone(void) const

Returns true if repository is in quiet zone mode

CHANNEL_TYPE get_msg_channel(int offset = 0) const

Returns the channel(s) to which the current message was sent, according to the datagram headers. This information is not available to the client.

int get_msg_channel_count(void) const
CHANNEL_TYPE get_msg_sender(void) const

Returns the sender ID of the current message, according to the datagram headers. This information is not available to the client.

unsigned int get_msg_type(void) const

INLINE unsigned char get_sec_code() const;

Returns the type ID of the current message, according to the datagram headers.

std::string const &get_overflow_event_name(void)

Returns event string that will be thrown if the datagram reader queue overflows.

QueuedConnectionManager &get_qcm(void)

Returns the QueuedConnectionManager object associated with the repository.

QueuedConnectionReader &get_qcr(void)

Returns the QueuedConnectionReader object associated with the repository.

bool get_simulated_disconnect(void) const

Returns the simulated disconnect flag. While this is true, no datagrams will be retrieved from or sent to the server. The idea is to simulate a temporary network outage.

SocketStream *get_stream(void)

Returns the SocketStream that internally represents the already-established HTTP connection. Returns NULL if there is no current HTTP connection.

int get_tcp_header_size(void) const

Returns the current setting of TCP header size. See set_tcp_header_size().

float get_time_warning(void) const

Returns the current setting of the time_warning field.

bool get_verbose(void) const

Returns the current setting of the verbose flag. When true, this describes every message going back and forth on the wire.

bool get_want_message_bundling(void) const

Returns true if message bundling enabled

bool has_owner_view(void) const

Returns true if this repository can have ‘owner’ views of distributed objects.

bool is_bundling_messages(void) const

Returns true if repository is queueing outgoing messages into a message bundle

bool is_connected(void)

Returns true if the connection to the gameserver is established and still good, false if we are not connected. A false value means either (a) we never successfully connected, (b) we explicitly called disconnect(), or (c) we were connected, but the connection was spontaneously lost.

bool send_datagram(Datagram const &dg)

Queues the indicated datagram for sending to the server. It may not get sent immediately if collect_tcp is in effect; call flush() to guarantee it is sent now.

void send_message_bundle(unsigned int channel, unsigned int sender_channel)

Send network messages queued up since start_message_bundle() was called.

void set_client_datagram(bool client_datagram)

Sets the client_datagram flag. If this is true, incoming datagrams are not expected to be prefixed with the server routing information like message sender, channel number, etc.; otherwise, these server fields are parsed and removed from each incoming datagram.

void set_connection_http(HTTPChannel *channel)

Once a connection has been established via the HTTP interface, gets the connection and uses it. The supplied HTTPChannel object must have a connection available via get_connection().

void set_handle_c_updates(bool handle_c_updates)

Set true to specify this repository should process distributed updates internally in C++ code, or false if it should return them to Python.

void set_handle_datagrams_internally(bool handle_datagrams_internally)

Sets the handle_datagrams_internally flag. When true, certain message types can be handled by the C++ code in in this module. When false, all datagrams, regardless of message type, are passed up to Python for processing.

The CMU distributed-object implementation requires this to be set false.

void set_in_quiet_zone(bool flag)

Enables/disables quiet zone mode

void set_python_repository(PyObject *python_repository)

Records the pointer to the Python class that derives from CConnectionRepository. This allows the C++ implementation to directly manipulation some python structures on the repository.

void set_simulated_disconnect(bool simulated_disconnect)

Sets the simulated disconnect flag. While this is true, no datagrams will be retrieved from or sent to the server. The idea is to simulate a temporary network outage.

void set_tcp_header_size(int tcp_header_size)

Sets the header size of TCP packets. At the present, legal values for this are 0, 2, or 4; this specifies the number of bytes to use encode the datagram length at the start of each TCP datagram. Sender and receiver must independently agree on this.

void set_time_warning(float time_warning)

Directly sets the time_warning field. When non zero, this describes every message going back and forth on the wire when the msg handling time is over it

void set_verbose(bool verbose)

Directly sets the verbose flag. When true, this describes every message going back and forth on the wire.

void set_want_message_bundling(bool flag)

Enable/disable outbound message bundling

void shutdown(void)

May be called at application shutdown to ensure all threads are cleaned up.

void start_message_bundle(void)

Send a set of messages to the state server that will be processed atomically. For instance, you can do a combined setLocation/setPos and prevent race conditions where clients briefly get the setLocation but not the setPos, because the state server hasn’t processed the setPos yet

void toggle_verbose(void)

Toggles the current setting of the verbose flag. When true, this describes every message going back and forth on the wire.

bool try_connect_net(URLSpec const &url)

Uses Panda’s “net” library to try to connect to the server and port named in the indicated URL. Returns true if successful, false otherwise.