panda3d.direct.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

__init__(has_owner_view: bool, threaded_net: bool) → None
getDcFile() → DCFile

Returns the DCFile object associated with this repository.

Return type

DCFile

hasOwnerView() → bool

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

setHandleCUpdates(handle_c_updates: bool) → None

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

getHandleCUpdates() → bool

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

setClientDatagram(client_datagram: bool) → None

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.

getClientDatagram() → bool

Returns the client_datagram flag.

setHandleDatagramsInternally(handle_datagrams_internally: bool) → None

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.

getHandleDatagramsInternally() → bool

Returns the handle_datagrams_internally flag.

setTcpHeaderSize(tcp_header_size: int) → None

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.

getTcpHeaderSize() → int

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

setPythonRepository(python_repository: object) → None

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.

setConnectionHttp(channel: HTTPChannel) → None

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().

getStream() → SocketStream

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

Return type

SocketStream

tryConnectNet(url: URLSpec) → bool

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.

getQcm() → QueuedConnectionManager

Returns the QueuedConnectionManager object associated with the repository.

Return type

QueuedConnectionManager

getCw() → ConnectionWriter

Returns the ConnectionWriter object associated with the repository.

Return type

ConnectionWriter

getQcr() → QueuedConnectionReader

Returns the QueuedConnectionReader object associated with the repository.

Return type

QueuedConnectionReader

connectNative(url: URLSpec) → bool

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

getBdc() → Buffered_DatagramConnection

Returns the Buffered_DatagramConnection object associated with the repository.

Return type

Buffered_DatagramConnection

checkDatagram() → bool

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

getDatagram(dg: Datagram) → None

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

getDatagramIterator(di: DatagramIterator) → None

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

getMsgChannel(offset: int) → CHANNEL_TYPE

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

Return type

CHANNEL_TYPE

getMsgChannelCount() → int
getMsgSender() → CHANNEL_TYPE

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

Return type

CHANNEL_TYPE

getMsgType() → int

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

static getOverflowEventName() → str

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

isConnected() → bool

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.

sendDatagram(dg: Datagram) → bool

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.

setWantMessageBundling(flag: bool) → None

Enable/disable outbound message bundling

getWantMessageBundling() → bool

Returns true if message bundling enabled

setInQuietZone(flag: bool) → None

Enables/disables quiet zone mode

getInQuietZone() → bool

Returns true if repository is in quiet zone mode

startMessageBundle() → None

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

isBundlingMessages() → bool

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

sendMessageBundle(channel: int, sender_channel: int) → None

Send network messages queued up since startMessageBundle was called.

abandonMessageBundles() → None

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

bundleMsg(dg: Datagram) → None
considerFlush() → bool

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

flush() → bool

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

disconnect() → None

Closes the connection to the server.

shutdown() → None

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

setSimulatedDisconnect(simulated_disconnect: bool) → None

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.

getSimulatedDisconnect() → bool

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.

toggleVerbose() → None

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

setVerbose(verbose: bool) → None

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

getVerbose() → bool

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

setTimeWarning(time_warning: float) → None

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

getTimeWarning() → float

Returns the current setting of the time_warning field.