FlowControl (p4java 2023.2.2581742 API)

java.lang.Object
- com.perforce.p4java.impl.mapbased.rpc.func.proto.FlowControl

```
public class FlowControl
extends java.lang.Object
```
Process and implement the various Perforce flow control commands, in particular the flush1 / flush2 pair.
In general, we keep a count of outstanding bytes and send a flush1 when it gets above the high water mark (hwm); we then wait for a corresponding flush2 before doing much else. The server does the same thing in reverse. This will all be explained in more detail later when the full implementation is much clearer... (HR).

Field Summary

Fields
Modifier and Type	Field and Description
`static long`	`DEFAULT_HI_MARK` Default maximum number of bytes allowed to be outstanding before we start worrying that we haven't seen a suitable flush2 response.
`static int`	`DEFAULT_LO_MARK` Default maximum number of bytes allowed to be outstanding before we send a flush1 message on duplex commands.
`static int`	`FLUSH_CMD_LENGTH` Length in bytes of a flush command when marshaled.
`static java.lang.String`	`TRACE_PREFIX`

Constructor Summary

Constructors
Constructor and Description

FlowControl(RpcPacketDispatcher mainDispatcher, java.util.Properties props)

Constructors
Constructor and Description
`FlowControl(RpcPacketDispatcher mainDispatcher, java.util.Properties props)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`decrementCurrentHiMark(int decr)`
`long`	`getCurrentHiMark()`
`long`	`getCurrentLoMark()`
`long`	`getHiMark()`
`long`	`getLoMark()`
`void`	`incrementCurrentHiMark(int incr)`
`void`	`processFlushCommandFromServer(RpcConnection rpcConnection, RpcFunctionSpec funcSpec, java.util.Map<java.lang.String,java.lang.Object> resultsMap)` Given a map passed-in from the main dispatcher that represents a flush command received from the Perforce server, respond appropriately.
`void`	`sendFlush1(RpcConnection rpcConnection, java.util.Map<java.lang.String,java.lang.Object> resultsMap)`
`void`	`sendFlush2(RpcConnection rpcConnection, java.util.Map<java.lang.String,java.lang.Object> resultsMap)`
`void`	`setCurrentHiMark(long currentHiMark)`
`void`	`setCurrentLoMark(long currentLoMark)`
`void`	`setHiMark(long hiMark)`
`void`	`setLoMark(long loMark)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TRACE_PREFIX
```
public static final java.lang.String TRACE_PREFIX
```
    See Also:
    
    Constant Field Values
  - FLUSH_CMD_LENGTH
```
public static final int FLUSH_CMD_LENGTH
```
    Length in bytes of a flush command when marshaled. This is actually a fiction -- it's more like 50 -- but the conservative sizing gives us a little leeway when things are tight (see the C++ API for a discussion on this -- we're just copying their behavior...).
    
    See Also:
    
    Constant Field Values
  - DEFAULT_LO_MARK
```
public static final int DEFAULT_LO_MARK
```
    Default maximum number of bytes allowed to be outstanding before we send a flush1 message on duplex commands. See the flow control documentation for an explanation of this and associated gubbins.
    
    See Also:
    
    Constant Field Values
  - DEFAULT_HI_MARK
```
public static final long DEFAULT_HI_MARK
```
    Default maximum number of bytes allowed to be outstanding before we start worrying that we haven't seen a suitable flush2 response. See the flow control documentation for an explanation of this and associated gubbins.
    
    See Also:
    
    Constant Field Values
- Constructor Detail
  - FlowControl
```
public FlowControl(RpcPacketDispatcher mainDispatcher,
                   java.util.Properties props)
```
- Method Detail
  - processFlushCommandFromServer
```
public void processFlushCommandFromServer(RpcConnection rpcConnection,
                                          RpcFunctionSpec funcSpec,
                                          java.util.Map<java.lang.String,java.lang.Object> resultsMap)
                                   throws ConnectionException
```
    Given a map passed-in from the main dispatcher that represents a flush command received from the Perforce server, respond appropriately. What "appropriately" means is very context-dependent; in general, if we see a flush1 we immediately attempt to send a flush2 with the same sequence number. If we see a flush2 we try to match it up with any outstanding flush1's we've already sent. This can get arbitrarily complex...
    
    Parameters:
    
    rpcConnection - connection
    
    funcSpec - spec
    
    resultsMap - map
    
    Throws:
    
    ConnectionException - on error
  - sendFlush1
```
public void sendFlush1(RpcConnection rpcConnection,
                       java.util.Map<java.lang.String,java.lang.Object> resultsMap)
```
  - sendFlush2
```
public void sendFlush2(RpcConnection rpcConnection,
                       java.util.Map<java.lang.String,java.lang.Object> resultsMap)
                throws ConnectionException
```
    Throws:
    
    ConnectionException
  - incrementCurrentHiMark
```
public void incrementCurrentHiMark(int incr)
```
  - decrementCurrentHiMark
```
public void decrementCurrentHiMark(int decr)
```
  - getLoMark
```
public long getLoMark()
```
  - setLoMark
```
public void setLoMark(long loMark)
```
  - getHiMark
```
public long getHiMark()
```
  - setHiMark
```
public void setHiMark(long hiMark)
```
  - getCurrentLoMark
```
public long getCurrentLoMark()
```
  - setCurrentLoMark
```
public void setCurrentLoMark(long currentLoMark)
```
  - getCurrentHiMark
```
public long getCurrentHiMark()
```
  - setCurrentHiMark
```
public void setCurrentHiMark(long currentHiMark)
```

Class FlowControl

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

TRACE_PREFIX

FLUSH_CMD_LENGTH

DEFAULT_LO_MARK

DEFAULT_HI_MARK

Constructor Detail

FlowControl

Method Detail

processFlushCommandFromServer

sendFlush1

sendFlush2

incrementCurrentHiMark

decrementCurrentHiMark

getLoMark

setLoMark

getHiMark

setHiMark

getCurrentLoMark

setCurrentLoMark

getCurrentHiMark

setCurrentHiMark