IBM 4J manual Waiting for a Message Using recvexitmsg or recvexitmsgc, Exitprogram

Page 83

Waiting for a Message Using recv_exit_msg() or recv_exit_msg_c()

The recv_exit_msg() or recv_exit_msg_c() function waits until it receives a message from Sterling Connect:Direct. Control is suspended until a message is received or an error occurs. The recv_exit_msg() has the following format:

int recv_exit_msg( int exit_flag ) int * msg_type,

char * recv_buf, int * recv_buf_len

The recv_exit_msg() or recv_exit_msg_c() functions have the following parameters:

Parameter	Description	Value

exit_flag	A flag to specify the recipient ID. The only valid	EXIT_PROGRAM
	value a user exit program can use is
	EXIT_PROGRAM.

msg_type	A pointer to the name of the received message.	Pointer to message
	Messages are requests from Sterling Connect:Direct
	and the associated response from the user exit
	program.

recv_buf	A pointer to the memory location of the message.	Pointer to message

recv_buf_len	The length in bytes of the message to be received.	Length of message

The recv_exit_msg()or recv_exit_msg_c() functions have the following return codes. Return codes for the function are defined in ndmapi.h.

Return Code

GOOD_RC

ERROR_RC

Description

The message was received successfully.

An error occurred and the message was not received successfully. Possible causes include: Sterling Connect:Direct terminated, an invalid value used for the exit_flag parameter, or the receiving buffer not large enough to hold the message received.

Passing a File Descriptor Using send_exit_file() or send_exit_file_c()

Use the send_exit_file() or send_exit_file_c() function to pass a file descriptor from one Process to another Process. Following is the format of send_exit_file():

int send_exit_file int exit_flag int fd

Following are the parameters for send_exit_file() or send_exit_file_c():

Parameter	Description	Value

exit_flag	A flag to specify the sender ID. The only valid value a	EXIT_PROGRAM
	user exit program can use is EXIT_PROGRAM.

fd	The file descriptor of a file that the user exit program	File descriptor
	opened in the place of Sterling Connect:Direct, similar to
	one returned by the open(2) function.

Chapter 5. Writing User Exits 77

Image 83

Contents User Guide Page User Guide Copyright IBM Corporation 1999 Contents Iv Sterling ConnectDirect for Unix User Guide Stopping the CLI Overview of the Command Line InterfaceCLI Commands Starting the CLIOption Description Value Entry Sample CommandCdpnum CLI Job ControlCommand Abbreviation Description CLI History CommandsOverview of Sterling ConnectDirect Commands CommandParameter Abbreviation Abbreviations for Common Sterling ConnectDirect CommandsParameter Description Values Submitting a ProcessPname = A?PROD5 Parameter Description Values Id , pswd Username@hostname or user@localhostName nnnnn Name host name nnn.nnn.nnn.nnn orSnodeid field Id ,pswd ,newpswdSpecify retain=initial Following command submits the Process named copyfil Following command submits the Process named payrollName generic list Following command submits the Process named copy.cdpChanging Process Parameters Parameter Description ValueNode specification, userid generic list Remote node specification generic listDeleting a Process from the TCQ Number list Removing a Process from the Execution Queue Stopping Sterling ConnectDirect Flush process command has the following optional parametersParameter Description Viewing a Process in the TCQPname Locate the Process to view EX HC HE HI HO HR HS PE Monitoring Process Status in the TCQ Following command displays the specified Process numberAll EX HC HE HI HO HR HS PE Output from the command is displayed in the following table Dest=/path/file name Determining the Outcome of a ProcessRecord id list Caev Capr CAEV, CaprParameter Description Value Parameter Description Value Parameter Description Value Date day , hhmmss ampm Srcf=/path/file nameGenerating a Detailed Output Report for a Process Recid LOG Timepname Pnumber Stepname Ccod Fdbk Msgid Running System DiagnosticsGenerating a Summary Report for a Process Select StatisticsCOMM.TRC Smgr Trace smgr pnode tnode=ath3500ry level=2 file=Smgp.trc Scheduling Parameter Queue Comments Command DefinitionOverview of the Transmission Control Queue Scheduling Sterling ConnectDirect ActivityProgression of a Process Through the TCQ Execution Queue Status Comment Wait QueueElement Comment Hold Queue Timer QueueHeld for Call indicates that the Process was Creating a Translation Table Introduction to Translation TablesExample-Creating a Translation Table Compiling a Translation Table Using the ndmxlt UtilityExample-Modifying a Model Translation Table Using Translation During File Transfer OperationsDiagnostic Number Description Translation Table Error MessagesAccessing Sterling ConnectDirect Messages Message File ContentFollowing are the parameters for the message file record Following is a sample ndmmsg commandMessage File Record Format Displaying Message TextSterling ConnectDirect for Unix User Guide Memory-The amount Using the Standalone Batch Compression UtilityFollowing are the parameters for the cdsacomp utility Level-Compression levelNnnnn Source codepage, destinationCodepage Example-Decompress a Text File Example-Precompress a Text FileExample-Precompress a Text File With Codepage Conversion Example-Precompress a Binary FileExamples-csdacomp Command Help Argument Description Validate Configuration FilesConfiguration Reports Cfgcheck command has the following argumentsType the following command at a Unix prompt Generating a Configuration Report on the Base InstallationSterling ConnectDirect Utilities Following example shows an excerpt from a sample report Sterling ConnectDirect Utilities Sterling ConnectDirect for Unix User Guide Compiler version to use for each platform Program using the C++ API callsIntroduction to Writing Custom Programs Compiling Custom ProgramsYou want to create such as apicheck Platform Compile Command++ Function Description Writing Custom C ProgramsNdmerrenth Ndmerror NdmnoerrorNdmapirecvrespc Receiving Responses Using ndmapirecvresp or ndmapirecvrespcNdmapirecvresp or Parameter Description Value PNOD-PNODE Truncated Following is a sample ndmapirecvresp functionSNOD-SNODE Return Code DescriptionNdmapirecvresp or ndmapirecvrespc to retrieve Selectstatistics or Selectprocess , the CLI Writing Custom C++ ProgramsNdmapisendcmdc function call has the following return codes Following is a sample ndmapisendcmd functionSterling ConnectDirect for Unix User Guide Cdfailure Method Description Parameter Return ValuesCdsuccess = 0, Cdfailure = Following is the ConnectDirectSession class headerWriting Custom Programs Sterling ConnectDirect for Unix User Guide Chown root exitskeleton User Exit ProgramsUser Exit Functions Program DescriptionReturn Code Goodrc ErrorrcExitprogram Waiting for a Message Using recvexitmsg or recvexitmsgcHeader Following are the parameters for sendexitmsg or sendexitmsgcFile Open Exit Messages Overview of User Exit MessagesStatistics Exit Message Fileopenoutputreplymsg Security Exit MessagesValidatemsg Validatereplymsg GeneratemsgExit Log Files User Exit Stop MessageCopy Control Block Copyright IBM Corp IBM Corporation J46A/G4 Bailey Avenue San Jose, CA Trademarks Sterling ConnectDirect for Unix User Guide Index Special characters Generatemsg Generatereplymsg Validatemsg Validatereplymsg Page Sterling ConnectDirect for Unix User Guide Page Product Number 5725-C99