com.ibm.cics.server
Class Chunk

java.lang.Object
  extended by com.ibm.cics.server.Chunk

public class Chunk
extends java.lang.Object

This class provides a mechanism by which a PIPELINE terminal handler program can send multiple response chunks of data in response to a remote Web request. This mechanism is only supported over HTTP 1.1.

Since CICS TS version:
4.1
Since package version:
1.201

Constructor Summary
Chunk()
           
 
Method Summary
 void sendResponseChunk()
          Sends the fragment of response data found in the DFHRESPONSE container as an HTTP chunk.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Chunk

public Chunk()
Method Detail

sendResponseChunk

public void sendResponseChunk()
                       throws NotSupportedException,
                              InvalidHandlerException,
                              PipelineMismatchException,
                              TransportException,
                              CicsException,
                              IncompatiblePipelineException
Sends the fragment of response data found in the DFHRESPONSE container as an HTTP chunk. The chunk is sent immediately - any PIPELINE handler programs attached to the PIPELINE are not notified. This method may be called multiple times. Each time it is driven a new chunk of data is returned to the remote client. When the terminal handler is ready to return the final chunk it should place the data in the DFHRESPONSE container and exit. At which point the normal PIPELINE response processing is driven for the final chunk. CICS handles generation of appropriate HTTP headers for the chunk in a similar fashion to how HTTP chunks are handled through the HttpResponse api.

Throws:
NotSupportedException - The pipeline of not of the correct type.
InvalidHandlerException - The method is called from a non terminal handler.
IncompatiblePipelineException - An incompatible handler is configured in the pipeline.
PipelineMismatchException - The pipeline is not a provider pipeline.
TransportException - A transport problem has occurred.
CicsException - An unexpected exception has occurred.
Since CICS TS version:
4.1
Since package version:
1.201