Class ProtocolCommand


  • public class ProtocolCommand
    extends java.lang.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 Detail

      • RPC_ARGNAME_PROTOCOL_CMPFILE

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_CMPFILE
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_CLIENT_API

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_CLIENT_API
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_APPLICATION_NAME

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_APPLICATION_NAME
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_SERVER_API

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_SERVER_API
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_SENDBUFSIZE

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_SENDBUFSIZE
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_RECVBUFSIZE

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_RECVBUFSIZE
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_ZTAGS

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_ZTAGS
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_ENABLE_STREAMS

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_ENABLE_STREAMS
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_ENABLE_GRAPH

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_ENABLE_GRAPH
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_ENABLE_TRACKING

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_ENABLE_TRACKING
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_ENABLE_PROGRESS

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_ENABLE_PROGRESS
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_HOST

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_HOST
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_PORT

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_PORT
        See Also:
        Constant Field Values
      • RPC_ARGNAME_PROTOCOL_IPADDR

        public static final java.lang.String RPC_ARGNAME_PROTOCOL_IPADDR
        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,
                               boolean enableGraph)
    • Method Detail

      • asMap

        public java.util.Map<java.lang.String,​java.lang.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 java.lang.String getApplicationName()
      • setApplicationName

        public void setApplicationName​(java.lang.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)
      • isEnableGraph

        public boolean isEnableGraph()
      • setEnableGraph

        public void setEnableGraph​(boolean enableGraph)
      • 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 java.lang.String getHost()
      • setHost

        public void setHost​(java.lang.String host)
      • getPort

        public java.lang.String getPort()
      • setPort

        public void setPort​(java.lang.String port)
      • getIpAddr

        public java.lang.String getIpAddr()
      • setIpAddr

        public void setIpAddr​(java.lang.String ipaddr)