Up

GSWeb: Class GSWLongResponsePage

Authors

Manuel Guesdon (mguesdon@orange-concept.com)

Version: 1.2

Date: 2002/11/23 11:06:39

Copyright: (C) 2002 Free Software Foundation, Inc.

Software documentation for the GSWLongResponsePage class

GSWLongResponsePage : GSWComponent

Declared in:
Foundation/GSWLongResponsePage.h
Conforms to:
NSLocking
Standards:

Description forthcoming.

Method summary

cancel 

- (GSWComponent*) cancel;

Description forthcoming.


cancelPageForStatus: 

- (GSWComponent*) cancelPageForStatus: (id)status;

Called when the process thread is cancelled. Replace -pageForResult: call. Default implementation stops automatic refresh and returns self.


isCancelled 

- (BOOL) isCancelled;

Return YES if action is canceled by the user. Used to abort thread. (Lock protected)


lock 

- (void) lock;

Locks the page


pageForException: 

- (GSWComponent*) pageForException: (NSException*)exception;

Called when an exception occur in the process thread. Replace -pageForResult: call. Default implemnetation raise the exception


pageForResult: 

- (GSWComponent*) pageForResult: (id)result;

Called when the process thread is done. Default implementation stops automatic refresh and returns self. You can override this to return a newly created result page


performAction 

- (id) performAction;

This method should be overwritten to return a result. Default implementation raise an exception Warning: you should first increase app worker thread count. count=1 ==> you code don't nead to be thread safe count>1 ==> if your code is not thread safe, you should disable concurrent request handling count>1 ==> if your code is thread safe, you can enable concurrent request handling


refresh 

- (GSWComponent*) refresh;

This method is call by GSWMetaRefresh -invokeAction . It can be manually called (for example if the page does not refresh itself. Status value make it call -pageForException: , -pageForResult: , -refreshPageForStatus: or -cancelPageForStatus: Don't override it


refreshInterval 

- (NSTimeInterval) refreshInterval;

Get the refresh interval.


refreshPageForStatus: 

- (GSWComponent*) refreshPageForStatus: (id)status;

Called on each refresh. Should return self.


setRefreshInterval: 

- (void) setRefreshInterval: (NSTimeInterval)interval;

Set the refresh interval. Default is 0. If >0, a refresh header is appended to the response


setStatus: 

- (void) setStatus: (id)status;

Set status (Lock protected)


unlock 

- (void) unlock;

Unlock the page



Up