c4d.modules.net

class c4d.modules.net

New in version R15.037.

Types

Functions Signatures

c4d.modules.net.SetErrorLevel(printDebugErrors, ...) Sets the level for stack and location in errors.
c4d.modules.net.GetGlobalNetRenderService() Get the global NET render service.
c4d.modules.net.VerificationStateToString(state) Format a verification state as a string.
c4d.modules.net.JobCommandToString(command) Format a job command as a string.
c4d.modules.net.JobStateToString(state) Format a job state as a string.
c4d.modules.net.NetSpecialEventAdd(service, remoteUuid, msg) Adds a custom event over NET.
c4d.modules.net.NetGeSyncMessage(service, remoteUuid, msg) Sends a synchronous event message over NET.

Functions Documentation

c4d.modules.net.SetErrorLevel(printDebugErrors, stackInErrors, locationInErrors)

Sets the level for stack and location in errors.

New in version R16.038.

Parameters:
  • printDebugErrors (bool) –

    New in version R16.050: True to print debug errors, otherwise False.

  • stackInErrors (bool) – True to enable stack in errors, otherwise False.
  • locationInErrors (bool) – True to enable location in errors, otherwise False.
c4d.modules.net.GetGlobalNetRenderService()

Get the global NET render service.

Return type:c4d.modules.net.NetRenderService
Returns:The global NET render service.
c4d.modules.net.VerificationStateToString(state)

Format a verification state as a string.

Parameters:state (int) –

The verification state:

VERIFICATIONBIT_NONE None.
VERIFICATIONBIT_ONLINE Online.
VERIFICATIONBIT_VERIFIED Verified.
VERIFICATIONBIT_VERIFIEDME Certified client (set on client for server).
VERIFICATIONBIT_SHARED Shared.
VERIFICATIONBIT_VERIFYING Verifying.
VERIFICATIONBIT_FAILURE Unknown.
VERIFICATIONBIT_SECURITYTOKENCHANGED Security token changed.
VERIFICATIONBIT_WRONGBUILDID Wrong build ID.
VERIFICATIONBIT_WRONGARCHITECTURE Wrong architecture.
VERIFICATIONBIT_REMOTENOTREACHABLE Remote not reachable.
VERIFICATIONBIT_THISNOTREACHABLE This not reachable.
VERIFICATIONBIT_WRONGSECURITYTOKEN Wrong security token.
VERIFICATIONBIT_DEMONOTACTIVATED Demo not activated.
VERIFICATIONBIT_REMOVING Removing.
VERIFICATIONBIT_NORENDERSUPPORT No render support.
VERIFICATIONBIT_INITIALIZING GUI flag only to show a please wait indicator on startup.
VERIFICATIONBIT_VERIFICATIONESTABLISHED Set soon after the persistent connection has been registered. Can be set without VERIFICATIONBIT_VERIFIED on first connect and host adds itself on the server.
Return type:str
Returns:The formatted verification state.
c4d.modules.net.JobCommandToString(command)

Format a job command as a string.

Parameters:command (int) –

The job command:

JOBCOMMAND_NONE Do nothing.
JOBCOMMAND_FETCHJOB Fetch job.
JOBCOMMAND_ALLOCATESPACE Allocate space.
JOBCOMMAND_DOWNLOAD Download.
JOBCOMMAND_RENDER Render.
JOBCOMMAND_DELETE Delete.
JOBCOMMAND_STOPANDDELETE Stop and delete.
JOBCOMMAND_ASSEMBLE Assemble.
JOBCOMMAND_END End.
Return type:str
Returns:The formatted job command.
c4d.modules.net.JobStateToString(state)

Format a job state as a string.

New in version R16.021.

Parameters:command (int) –

The job state:

JOBSTATE_IDLE Idle.
JOBSTATE_PREPARING_RUNNING Preparing running. Preparing only for server in async mode for NetRenderService.StartRendering().
JOBSTATE_PREPARING_FAILED Preparing failed.
JOBSTATE_PREPARING_OK Preparing ok.
JOBSTATE_RENDER_RUNNING Render running.
JOBSTATE_RENDER_OK Render ok.
JOBSTATE_RENDER_FAILED Render failed.
JOBSTATE_ALLOCATESPACE_RUNNING Allocate space running.
JOBSTATE_ALLOCATESPACE_OK Allocate space ok.
JOBSTATE_ALLOCATESPACE_FAILED Allocated space failed.
JOBSTATE_DOWNLOAD_RUNNING Download running.
JOBSTATE_DOWNLOAD_OK Download ok.
JOBSTATE_DOWNLOAD_FAILED Download failed.
JOBSTATE_ASSEMBLE_RUNNING Assemble running.
JOBSTATE_ASSEMBLE_OK Assemble ok.
JOBSTATE_ASSEMBLE_FAILED Assemble failed.
JOBSTATE_STOPPED Stopped.
JOBSTATE_QUEUED Queued.
JOBSTATE_PENDING Non-native state which is only available in the server when no machine is involved in a running job.
JOBSTATE_QUEUED_WAITING

New in version R18: Queued waiting.
JOBSTATE_ASSEMBLE_PENDING

New in version R17.053: Allocate space running.
Return type:str
Returns:The formatted job state.
c4d.modules.net.NetSpecialEventAdd(service, remoteUuid, msg, forceConnect=True)

Adds a custom event over NET.

New in version R16.021.

Parameters:
Return type:

bool
Returns:

True if successful, otherwise False.
c4d.modules.net.NetGeSyncMessage(service, remoteUuid, msg, forceConnect=True)

Sends a synchronous event message over NET.

New in version R16.021.

Parameters:
Return type:

tuple(bool, BaseContainer)
Returns:

The successful status and result container.