public interface IStreamingServer extends IOptionsServer
ATTRIBUTE_STREAM_MAP_KEY, IN_MAP_USE_TAGS_KEY| Modifier and Type | Method and Description |
|---|---|
void |
execStreamingMapCommand(java.lang.String cmdName,
java.lang.String[] cmdArgs,
java.util.Map<java.lang.String,java.lang.Object> inMap,
IStreamingCallback callback,
int key)
Issue a streaming map command to the Perforce server, using an optional
map for any input expected by the server (such as label or job specs,
etc.).
|
addTrust, addTrust, addTrust, execInputStringMapCmdList, execInputStringMapCmdList, execInputStringStreamCmd, execInputStringStreamingMapCmd, execMapCmdList, execQuietMapCmdList, execStreamCmd, getAuthId, getTicketsFilePath, getTrust, getTrustFilePath, getTrusts, getTrusts, getUsageOptions, removeTrust, removeTrust, setAuthTicket, setAuthTicket, setTicketsFilePath, setTrustFilePath, setUsageOptionsconnect, createUserGroup, deleteUserGroup, disconnect, execInputStringMapCmd, execInputStringStreamingMapComd, execMapCmd, execQuietMapCmd, execQuietStreamCmd, execStreamingMapCommand, getAuthTicket, getAuthTicket, getAuthTicket, getChangelistDiffs, getCharsetName, getCommitFiles, getCurrentClient, getCurrentServerInfo, getGenericCode, getInterchanges, getInterchanges, getKnownCharsets, getProperties, getServerVersion, getServerVersionNumber, getSeverityCode, getStatus, getUserGroups, getUserName, getWorkingDirectory, isCaseSensitive, isConnected, isLoginNotRequired, registerBrowserCallback, registerCallback, registerProgressCallback, registerSSOCallback, setAuthTicket, setCharsetName, setClientPath, setCurrentClient, setCurrentServerInfo, setUserName, setWorkingDirectory, supportsSmartMove, supportsUnicode, updateUserGroupexecMapCmdList, execMapCmdList, execMapCmdList, execStreamCmd, execStreamCmdForBuffer, getErrorOrInfoStr, getErrorStr, getInfoStr, handleErrorStr, handleFileErrorStr, isAuthFail, isInfoMessagesetFileAttributes, setFileAttributes, unsetFileAttribute, unsetFileAttributescreateBranchSpec, deleteBranchSpec, deleteBranchSpec, getBranchSpec, getBranchSpec, updateBranchSpecgetBranchSpecs, getBranchSpecsdeletePendingChangelist, deletePendingChangelist, getChangelist, getChangelistgetChangelists, getChangelists, getChangelistscreateClient, createTempClient, deleteClient, deleteClient, getClient, getClient, getClientTemplate, getClientTemplate, getClientTemplate, switchClientView, switchStreamView, updateClient, updateClient, updateClientgetClients, getClientssetOrUnsetServerConfigurationValue, showServerConfigurationdeleteCounter, getCounter, getCounter, setCounter, setCountergetCounters, getCounters, getCountersgetDbSchemacreateDepot, deleteDepot, getDepotgetDepots, getDepotsgetRepos, getRepos, getReposgetChangelistDiffs, getChangelistDiffsStream, getChangelistExtendedFiles, getChangelistExtendedFiles, getChangelistFiles, getChangelistFiles, getShelvedFiles, getShelvedFilesgetFileDiffs, getFileDiffs, getFileDiffsStream, getServerFileDiffsgetDirectories, getDirectoriesgetDiskSpaceduplicateRevisionsgetExportRecords, getExportRecords, getStreamingExportRecordsgetFileAnnotations, getFileAnnotationsgetRevisionHistory, getRevisionHistorygetDepotFiles, getDepotFilesfixJobs, fixJobsgetFixes, getFixListgetExtendedFiles, getExtendedFilesgetMatchingLines, getMatchingLinescreateUserGroup, deleteUserGroup, getUserGroup, updateUserGroupgetUserGroupsgetServerInfogetSubmittedIntegrations, getSubmittedIntegrationsgetInterchanges, getInterchangesgetStreamIntegrationStatuscreateJob, deleteJob, getJob, updateJobgetJobs, getJobsgetJobSpecjournalWaitdeleteKey, getKey, setKeygetKeyscreateLabel, deleteLabel, deleteLabel, getLabel, updateLabelgetLabels, getLabelsgetLoginStatus, isDontWriteTicket, login, login, login, login, loginlogout, logoutgetLogTailgetServerProcesses, getServerProcessesmoveFile, moveFileobliterateFilesgetOpenedFiles, getOpenedFileschangePasswordgetFileContents, getFileContents, getFileContentsdeleteProperty, getProperty, setPropertycreateProtectionEntries, getProtectionsTable, updateProtectionEntriesgetProtectionEntries, getProtectionEntriesreloadrenameUsergetReviewChangelistsgetReviews, getReviewssearchJobsgetFileSizescreateStream, deleteStream, getStream, getStream, updateStreamgetStreamstagFiles, tagFilescreateTriggerEntries, getTriggerEntries, getTriggersTable, updateTriggerEntriesunloadcreateUser, createUser, deleteUser, deleteUser, getUser, updateUser, updateUsergetUsers, getUsersverifyFilesgetGraphListTreegetBlobObject, getCommitObject, getCommitObject, getGraphCommitLogList, getGraphObjectgetGraphRevListgetGraphCommitLogListdoGraphReceivePackgetListData, getListDatagetGraphShowRefsgetLogin2Status, getLogin2Status, login2, login2, login2CheckAuth, login2InitAuth, login2ListMethodsgetSpec, updateSpec, updateSpecStringgetLicense, getLimits, getValidServerIPMACAddress, updateLicensecreateExtensionConfig, deleteExtension, getExtensionConfig, installExtension, listExtensions, packageExtension, sampleExtension, updateExtensionConfiggetStreamlogrenameClientvoid execStreamingMapCommand(java.lang.String cmdName,
java.lang.String[] cmdArgs,
java.util.Map<java.lang.String,java.lang.Object> inMap,
IStreamingCallback callback,
int key)
throws P4JavaException
IServerStreaming commands allow users to get each result from a suitably-issued command as it comes in from the server, rather than waiting for the entire command method to complete (and getting the results back as a completed List or Map or whatever).
The results are sent to the user using the IStreamingCallback handleResult method; see the IStreamingCallback Javadoc for details. The payload passed to handleResult is usually the raw map gathered together deep in the RPC protocol layer, and the user is assumed to have the knowledge and technology to be able to parse it and use it suitably in much the same way as a user unpacks or processes the results from the other low-level exec methods like execMapCommand.
NOTE: 'streaming' here has nothing at all to do with Perforce 'streams', which are (or will be) implemented elsewhere.
execStreamingMapCommand in interface IServercmdName - the command to be issued; must be non-null, and correspond to
a Perforce command recognized by P4Java and defined in
CmdSpec.cmdArgs - the array of command arguments (options and file arguments,
etc.) to be sent to the Perforce server. These must be in the
form used by the corresponding p4 command line interpreter.
Ignored if null.inMap - an optional map to be sent to the server as standard input,
using the Python map format (-G) form. You must remember to
issue the relevant command-specific option to enable this if
needed.callback - a non-null IStreamingCallback to be used to process the
incoming results.key - an opaque integer key that is passed to the IStreamingCallback
callback methods to identify the action as being associated
with this specific call.P4JavaException - if an error occurs processing this method and its parameters.