com.perforce.p4java.impl.mapbased.rpc.func.proto
Class ProtocolCommand

java.lang.Object
  extended by com.perforce.p4java.impl.mapbased.rpc.func.proto.ProtocolCommand

public class ProtocolCommand
extends Object

Used to specify Perforce RPC protocol-related parameters on the first call to a Perforce server on an RPC connection.

Much of this has been cribbed from the corresponding C++ API protocol specs, and will probably need revisiting with experience. In general, don't change values here unless you know what you're doing, as they can have considerable effects on client- and server-side behaviours.


Field Summary
static String RPC_ARGNAME_PROTOCOL_APPLICATION_NAME
           
static String RPC_ARGNAME_PROTOCOL_CLIENT_API
           
static String RPC_ARGNAME_PROTOCOL_CMPFILE
           
static String RPC_ARGNAME_PROTOCOL_ENABLE_PROGRESS
           
static String RPC_ARGNAME_PROTOCOL_ENABLE_STREAMS
           
static String RPC_ARGNAME_PROTOCOL_ENABLE_TRACKING
           
static String RPC_ARGNAME_PROTOCOL_HOST
           
static String RPC_ARGNAME_PROTOCOL_PORT
           
static String RPC_ARGNAME_PROTOCOL_RECVBUFSIZE
           
static String RPC_ARGNAME_PROTOCOL_SENDBUFSIZE
           
static String RPC_ARGNAME_PROTOCOL_SERVER_API
           
static String RPC_ARGNAME_PROTOCOL_ZTAGS
           
 
Constructor Summary
ProtocolCommand()
           
ProtocolCommand(int clientApiLevel, boolean clientCmpFile, int serverApiLevel, int sendBufSize, int recvBufSize, boolean useTags)
           
ProtocolCommand(int clientApiLevel, boolean clientCmpFile, int serverApiLevel, int sendBufSize, int recvBufSize, boolean useTags, boolean enableStreams)
           
 
Method Summary
 Map<String,Object> asMap()
           
 String getApplicationName()
           
 int getClientApiLevel()
           
 String getHost()
           
 String getPort()
           
 int getRecvBufSize()
           
 int getSendBufSize()
           
 int getServerApiLevel()
           
 boolean isClientCmpFile()
           
 boolean isEnableProgress()
           
 boolean isEnableStreams()
           
 boolean isEnableTracking()
           
 boolean isQuietMode()
           
 boolean isUseTags()
           
 void setApplicationName(String applicationName)
           
 void setClientApiLevel(int clientApiLevel)
           
 void setClientCmpFile(boolean clientCmpFile)
           
 void setEnableProgress(boolean enableProgress)
           
 void setEnableStreams(boolean enableStreams)
           
 void setEnableTracking(boolean enableTracking)
           
 void setHost(String host)
           
 void setPort(String port)
           
 void setQuietMode(boolean quietMode)
           
 void setRecvBufSize(int recvBufSize)
           
 void setSendBufSize(int sendBufSize)
           
 void setServerApiLevel(int serverApiLevel)
           
 void setUseTags(boolean useTags)
           
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

RPC_ARGNAME_PROTOCOL_CMPFILE

public static final String RPC_ARGNAME_PROTOCOL_CMPFILE
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_CLIENT_API

public static final String RPC_ARGNAME_PROTOCOL_CLIENT_API
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_APPLICATION_NAME

public static final String RPC_ARGNAME_PROTOCOL_APPLICATION_NAME
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_SERVER_API

public static final String RPC_ARGNAME_PROTOCOL_SERVER_API
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_SENDBUFSIZE

public static final String RPC_ARGNAME_PROTOCOL_SENDBUFSIZE
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_RECVBUFSIZE

public static final String RPC_ARGNAME_PROTOCOL_RECVBUFSIZE
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_ZTAGS

public static final String RPC_ARGNAME_PROTOCOL_ZTAGS
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_ENABLE_STREAMS

public static final String RPC_ARGNAME_PROTOCOL_ENABLE_STREAMS
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_ENABLE_TRACKING

public static final String RPC_ARGNAME_PROTOCOL_ENABLE_TRACKING
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_ENABLE_PROGRESS

public static final String RPC_ARGNAME_PROTOCOL_ENABLE_PROGRESS
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_HOST

public static final String RPC_ARGNAME_PROTOCOL_HOST
See Also:
Constant Field Values

RPC_ARGNAME_PROTOCOL_PORT

public static final String RPC_ARGNAME_PROTOCOL_PORT
See Also:
Constant Field Values
Constructor Detail

ProtocolCommand

public ProtocolCommand()

ProtocolCommand

public ProtocolCommand(int clientApiLevel,
                       boolean clientCmpFile,
                       int serverApiLevel,
                       int sendBufSize,
                       int recvBufSize,
                       boolean useTags)

ProtocolCommand

public ProtocolCommand(int clientApiLevel,
                       boolean clientCmpFile,
                       int serverApiLevel,
                       int sendBufSize,
                       int recvBufSize,
                       boolean useTags,
                       boolean enableStreams)
Method Detail

asMap

public Map<String,Object> asMap()

getClientApiLevel

public int getClientApiLevel()

setClientApiLevel

public void setClientApiLevel(int clientApiLevel)

isClientCmpFile

public boolean isClientCmpFile()

setClientCmpFile

public void setClientCmpFile(boolean clientCmpFile)

getServerApiLevel

public int getServerApiLevel()

setServerApiLevel

public void setServerApiLevel(int serverApiLevel)

getApplicationName

public String getApplicationName()

setApplicationName

public void setApplicationName(String applicationName)

getSendBufSize

public int getSendBufSize()

setSendBufSize

public void setSendBufSize(int sendBufSize)

getRecvBufSize

public int getRecvBufSize()

setRecvBufSize

public void setRecvBufSize(int recvBufSize)

isUseTags

public boolean isUseTags()

setUseTags

public void setUseTags(boolean useTags)

isEnableStreams

public boolean isEnableStreams()

setEnableStreams

public void setEnableStreams(boolean enableStreams)

isEnableTracking

public boolean isEnableTracking()

setEnableTracking

public void setEnableTracking(boolean enableTracking)

isEnableProgress

public boolean isEnableProgress()

setEnableProgress

public void setEnableProgress(boolean enableProgress)

isQuietMode

public boolean isQuietMode()

setQuietMode

public void setQuietMode(boolean quietMode)

getHost

public String getHost()

setHost

public void setHost(String host)

getPort

public String getPort()

setPort

public void setPort(String port)


Copyright © 2015 Perforce Software. All Rights Reserved.