#include <PacketStream.h>
Inheritance diagram for GNE::PacketStream:
Public Types | |
| typedef SmartPtr< PacketStream > | sptr |
| typedef WeakPtr< PacketStream > | wptr |
Public Member Functions | |
| virtual | ~PacketStream () |
| Destroys this object. | |
| int | getInLength () const |
| Returns the current incoming queue length in packets. | |
| int | getOutLength (bool reliable) const |
| Returns the current outgoing queue length in packets. | |
| void | setFeeder (const SmartPtr< PacketFeeder > &newFeeder) |
| Sets a new PacketFeeder that this class uses to generate onLowPackets events to. | |
| void | setLowPacketThreshold (int limit) |
| When the number of packets in this PacketStream falls below limit, at least one onLowPackets event is generated. | |
| int | getLowPacketThreshold () const |
| Returns the current low packet threshold. | |
| void | setFeederTimeout (int ms) |
| Sets the feeder timeout in milliseconds. | |
| int | getFeederTimeout () const |
| Returns the set feeder timeout. | |
| bool | isNextPacket () const |
| Is there at least one packet in the incoming queue? Note that this does not guarantee that getNextPacket will return a non-NULL value if it is possible for any other thread to try to get the data between your call and getNextPacket. | |
| Packet * | getNextPacket () |
| Returns the next packet from the queue, removing it from that queue. | |
| SmartPtr< Packet > | getNextPacketSp () |
| Returns the next packet from the queue, removing it from that queue. | |
| void | writePacket (const Packet &packet, bool reliable) |
| Adds a packet to the outgoing queue. | |
| void | writePacket (const SmartPtr< Packet > &packet, bool reliable) |
| Adds a packet to the outgoing queue. | |
| int | getCurrOutRate () const |
| Returns the actual outgoing data rate, which may be the same or less that what was originally requested on connection. | |
| int | getReqOutRate () const |
| Returns the maximum outgoing rate that we are requesting. | |
| int | getRemoteOutLimit () const |
| Returns the maximum outgoing rate that the remote computer is allowing us to send to it. | |
| void | setRates (int reqOutRate2, int maxInRate2) |
| Sets new values that we are willing to send or receive. | |
| void | waitToSendAll (int waitTime=10000) const |
| Blocks on this PacketStream until all packets have been sent. | |
| void | shutDown () |
| Overrides Thread::shutDown so that the PacketStream daemon thread will be woken up since it might be waiting on a ConditionVariable. | |
| void | addIncomingPacket (Packet *packet) |
| Add the given packet to the incoming queue. | |
Static Public Member Functions | |
| sptr | create (int reqOutRate, int maxOutRate, Connection &ourOwner) |
| Creates a new PacketStream with the given flow control parameters. | |
Protected Member Functions | |
| PacketStream (int reqOutRate, int maxOutRate, Connection &ourOwner) | |
| void | run () |
NOTE: all functions in this class are thread safe, since this class uses its own mutexes internally. Note that data in the class may change between calls, if another thread changes its state.
|
||||||||||||||||
|
|
|
|
Destroys this object. Any data left remaining in the in or out queues is destroyed as well. |
|
|
Add the given packet to the incoming queue.
This is normalled used internally by the Connection class to add the packets, but it is safe for the user to call, if they want to delay processing of the packets for a later time and see what other packets are available. |
|
||||||||||||||||
|
Creates a new PacketStream with the given flow control parameters. Passing a value 0 for a rate is interpreted as "unlimited" or unrestricted rates. Passing a value less than 0 is not allowed. By default no PacketFeeder is set.
|
|
|
Returns the actual outgoing data rate, which may be the same or less that what was originally requested on connection. This value is the minimum between the max rate limit from the remote computer, and our maximum outgoing rate. A value of 0 means there is no outgoing rate limit. If the requested rate changes, or if the remote computer changes its max allowed limit, this number will change to the new minimum between these rates. |
|
|
Returns the next packet from the queue, removing it from that queue. It is your responsibility to deallocate the memory for this packet as the calling code becomes the owner of the memory the returned packet occupies. You deallocate the Packet by using the PacketStream::destroyPacket function.
|
|
|
Returns the next packet from the queue, removing it from that queue. The Sp stands for "SmartPtr" and returns a SmartPtr that will handle the PacketStream::destroyPacket call for you.
|
|
|
Returns the current outgoing queue length in packets. This is meant as a possible hint for your application to tune its performance by knowning when the queues are starting to fill up.
|
|
|
Returns the maximum outgoing rate that the remote computer is allowing us to send to it. This value can change if the remote machine changes its rates through the setRates function. The value 0 means that no limit was requested.
|
|
|
Returns the maximum outgoing rate that we are requesting. The value 0 means that no rate limit was requested.
|
|
|
Is there at least one packet in the incoming queue? Note that this does not guarantee that getNextPacket will return a non-NULL value if it is possible for any other thread to try to get the data between your call and getNextPacket. This is only useful if you want to passively check for incoming data. If you are wanting to do anything with that data it is suggested that you use getNextPacket and if it is non-NULL then process the data. That method is thread safe. |
|
|
Implements GNE::Thread. |
|
|
Sets a new PacketFeeder that this class uses to generate onLowPackets events to. This function blocks until the feeder has been changed. When the PacketStream starts with no packets and a feeder becomes set the first onLowPackets will be generated, so that your PacketFeeder can be used even to generate the initial packets after the connection event. The onLowPackets event will be flagged to be triggered when this function is called if conditions are proper, disregarding the timeout -- meaning if you set a feeder for a connection with no packets in the outgoing queue, an onLowPackets event will be generated. The passed newFeeder may be NULL in which case onLowPackets events will not be generated. After the connection has been disconnected, the reference to the feeder is dropped to prevent cycles. After disconnection, this method no longer has any effect. |
|
|
Sets the feeder timeout in milliseconds. If the feeder chooses not to send packets when the threshold is low, then the PacketStream will run out of packets and go to sleep. This timeout is an approximate time the PacketStream will wait before generating a new onLowPackets event if still no packets are ready for writing. If this value is 0, then onLowPackets will never be called again until packets are written from an external thread. A value less than 0 is invalid. There is no guarantee made about how accurate the callback rate will actually be, except that one will eventually happen with a non-zero timeout and that it will likely be called too soon rather than too late, since some method invocations on PacketStream will trigger a premature timeout. |
|
|
When the number of packets in this PacketStream falls below limit, at least one onLowPackets event is generated. If this value is 0, then the event will only be generated when the queue empties entirely. The conditions for an onLowPackets event will be reevaluated when this method is called without regard to the timeout, and an onLowPackest event will be generated if the conditions are proper. |
|
||||||||||||
|
Sets new values that we are willing to send or receive. See the constructor for more information. Pass a value less than 0 to leave one of the rates unchanged. Pass the value 0 for "unrestricted" rates. Changing the rates might cause a packet to get added to the outgoing packet stream to communicate this change to the other side.
|
|
|
Blocks on this PacketStream until all packets have been sent. Note that if you have set an active packet feeder, and it is constaly adding packets to the queue, this function is likely not to return until it times out, so you may want to communicate with that feeder somehow or turn off the feeder (by setting a NULL feeder) so more packets are not being continuously added.
|
|
||||||||||||
|
Adds a packet to the outgoing queue. The packet given will be copied. This works identical to the other writePacket but takes a SmartPtr to a Packet.
|
|
||||||||||||
|
Adds a packet to the outgoing queue. The packet given will be copied.
|
1.3