FEPI RECEIVE DATASTREAM

Function

FEPI RECEIVE DATASTREAM receives data from a target and places the received data stream into the application’s data area. Full details about the data are given in Data formats.

By default, FEPI RECEIVE DATASTREAM completes when a whole chain of data has been received. A time limit can be set for this command. For more details of ending conditions, see Ending status.

Syntax

Read syntax diagramSkip visual syntax diagramFEPI RECEIVE DATASTREAM
 
                                                .-CHAIN-----.
>>-FEPI RECEIVE DATASTREAM--CONVID(data-value)--+-----------+--->
                                                +-RU--------+
                                                '-UNTILCDEB-'
 
>--+-----------------+--+-----------------+--------------------->
   '-ENDSTATUS(cvda)-'  '-FMHSTATUS(cvda)-'
 
>--+----------------------------------+------------------------->
   '-INTO(data-area)-| INTO options |-'
 
>--+-----------------------+--+------------------+-------------->
   '-REMFLENGTH(data-area)-'  '-RESPSTATUS(cvda)-'
 
>--+---------------------+--+----------------------+------------>
   '-SEQNUMIN(data-area)-'  '-SEQNUMOUT(data-area)-'
 
>--+---------------------+-------------------------------------><
   '-TIMEOUT(data-value)-'
 
INTO options:
 
|--+------------------------+--+--------------------+-----------|
   '-MAXFLENGTH(data-value)-'  '-FLENGTH(data-area)-'
 

Options

CHAIN
specifies that the command should complete when a whole chain has been received.
CONVID(8-character data-value)
specifies the ID of the conversation to use. The conversation must be owned by the task issuing the command.
ENDSTATUS(cvda)
returns a value that indicates the ending status for the received data. The relevant CVDA values are:
Value
Meaning
CD
‘Change direction’ received.
EB
‘End bracket’ received.
LIC
‘Last in chain’ received.
RU
RU received.
MORE
The data area identified by the INTO option was too small to receive all the requested data.
For more details of ending status and how additional data is handled, see Ending status.
FLENGTH(fullword binary data-area)
returns the actual length of data received in the data area identified by the INTO option.
FMHSTATUS(cvda)
returns a value that indicates whether the received data contains a function management header. The relevant CVDA values are:
  • FMH
  • NOFMH
INTO(data-area)
specifies the data area in which the received data is to be returned. The length of the area is specified by the MAXFLENGTH option, and the actual length of data written into the area is returned by the FLENGTH option.
MAXFLENGTH(fullword binary data-value)
specifies the maximum amount of data that can be returned; that is, the length of the data area identified by the INTO option. It must not be more than the maximum length allowed for the pool.
REMFLENGTH(fullword binary data-area)
returns the length, if known, of data remaining after filling the data area identified by the INTO option.
RESPSTATUS(cvda)
returns a value that indicates the type of response that is required at the back-end system. The relevant CVDA values are:
Value
Meaning
DEFRESP1
Definite response 1 required.
DEFRESP2
Definite response 2 required.
DEFRESP3
Definite response 1 and definite response 2 required.
NONE
No response required.
RU
specifies that the command should complete when a request unit has been received.
SEQNUMIN(fullword binary data-area)
in SLU P mode, returns the current sequence number for inbound data, as at the completion of the command. (SEQNUMIN has no significance in SLU2 mode.)
SEQNUMOUT(fullword binary data-area)
in SLU P mode, returns the current sequence number for outbound data, as at the completion of the command. (SEQNUMOUT has no significance in SLU2 mode.)
TIMEOUT(fullword binary data-value)
specifies the maximum time in seconds that the command is to wait for the requested data to begin to arrive. If TIMEOUT is not specified or the specified time is zero, the command is not timed out.
UNTILCDEB
specifies that the command should complete when ‘change direction’ or ‘end bracket’ is received.

Conditions

The INVREQ condition can have the following RESP2 values:

RESP2
Meaning
60
MAXFLENGTH value negative or more than maximum allowed for the current pool.
71
VTAM RECEIVE failed.
212
Conversation has wrong data format.
215
Session lost.
216
Error occurred on previous FEPI SEND.
221
FEPI RECEIVE not allowed at this point in the conversation.
224
Only FEPI ISSUE or FEPI FREE commands allowed at this point in the conversation.
230
SNA CLEAR command received.
231
SNA CANCEL command received.
232
SNA CHASE command received.
233
Exception response received.
234
Exception request received.
240
Conversation ID not owned by this task.
241
TIMEOUT value negative or not valid.
[[ Contents Previous Page | Next Page Index ]]