Annotation of libwww/Library/src/HTAlert.html, revision 2.55
2.6 timbl 1: <HTML>
2: <HEAD>
2.51 frystyk 3: <!-- Changed by: Henrik Frystyk Nielsen, 13-Jul-1996 -->
2.46 frystyk 4: <TITLE>W3C Sample Code Library libwww Library Alert Class</TITLE>
2.6 timbl 5: </HEAD>
6: <BODY>
2.38 frystyk 7: <H1>
8: The Alert Class
9: </H1>
2.12 frystyk 10: <PRE>
11: /*
2.18 frystyk 12: ** (c) COPYRIGHT MIT 1995.
2.12 frystyk 13: ** Please first read the full copyright statement in the file COPYRIGH.
14: */
15: </PRE>
2.38 frystyk 16: <P>
17: The Alert class defines a set of methods to be used by libwww to be used
18: for passing prompts and message to a user. In order to maintain the Library
19: core application independent and natural language independent, libwww does
20: not know how to communicate with a <I>user</I>. Note here that a <I>user</I>
21: is a somewhat abstract notion for something that can receive a message
22: or prompt from the Library. This can for example be a person, but is may
23: also be handled automatically by a robot or a client receiving a response
24: from a HTTP server.
25: <P>
26: Libwww has a set of <B>opcodes</B> that classifies the nature of the message,
27: for example that it is a question that must be confirmed in order to continue
28: a request or simply a progress notification. The application can register
29: a method for any number of the defined opcodes - in case the Library has
30: a message for an opcode that does not have a method associated, the message
31: is ignored. You can also globally disable any message send from the Library.
32: <P>
33: <B>Note</B>: The library <B>core</B> does not define any message or dialog
34: methods - they are all considered part of the application. The library comes
35: with a <A HREF="HTDialog.html">default set of methods</A> which can be initiated
36: using the function <CODE>HTAlertInit()</CODE> in <A HREF="HTInit.html">HTInit
37: module</A>
38: <P>
39: This module is implemented by <A HREF="HTAlert.c">HTAlert.c</A>, and it is
2.50 frystyk 40: a part of the <A HREF="http://www.w3.org/Library/"> W3C Sample Code
2.38 frystyk 41: Library</A>.
2.11 frystyk 42: <PRE>
2.12 frystyk 43: #ifndef HTALERT_H
44: #define HTALERT_H
2.17 frystyk 45:
2.27 frystyk 46: #include "HTReq.h"
2.11 frystyk 47: </PRE>
2.38 frystyk 48: <H2>
2.55 ! frystyk 49: <A NAME="Message">Message Opcodes and Messages</A>
2.38 frystyk 50: </H2>
51: <P>
52: The callback functions are defined as a generic callback where the caller
53: can pass a set of input parameters and the callee can return a set of outptu
54: parameters. Also note that all the <CODE>*_PROG_*</CODE> opcodes are a subset
55: of <CODE>HT_A_PROGRESS</CODE>. This means that you easily can register a
56: callback for <EM>all</EM> progress reports.
2.32 frystyk 57: <PRE>
58: typedef enum _HTAlertOpcode {
59: HT_PROG_DNS = 0x1, /* Doing DNS resolution */
60: HT_PROG_CONNECT = 0x2, /* Connecting Active */
61: HT_PROG_ACCEPT = 0x4, /* Connecting Passive */
62: HT_PROG_READ = 0x8, /* Read data */
63: HT_PROG_WRITE = 0x10, /* Write data */
64: HT_PROG_DONE = 0x20, /* Request finished */
2.53 frystyk 65: HT_PROG_INTERRUPT = 0x40, /* Request interrupted */
66: HT_PROG_OTHER = 0x80, /* Other progress notes */
67: HT_PROG_TIMEOUT = 0x100, /* Request timed out */
2.54 frystyk 68: HT_PROG_LOGIN = 0x200, /* Automatic login notifications */
2.53 frystyk 69: HT_A_PROGRESS = 0xFFFF, /* Get all progress reports - no reply */
2.32 frystyk 70:
71: /* First word are reserved for progresss notifications */
72:
2.53 frystyk 73: HT_A_MESSAGE = 0x1<<16, /* Send a message - no reply */
74: HT_A_CONFIRM = 0x2<<16, /* Want YES or NO back */
75: HT_A_PROMPT = 0x4<<16, /* Want full dialog */
76: HT_A_SECRET = 0x8<<16, /* Secret dialog (e.g. password) */
77: HT_A_USER_PW = 0x10<<16 /* Atomic userid and password */
2.32 frystyk 78: } HTAlertOpcode;
2.15 frystyk 79:
2.32 frystyk 80: typedef struct _HTAlertPar HTAlertPar;
2.8 luotonen 81:
2.32 frystyk 82: typedef BOOL HTAlertCallback (HTRequest * request, HTAlertOpcode op,
2.35 frystyk 83: int msgnum, const char * dfault, void * input,
2.32 frystyk 84: HTAlertPar * reply);
2.6 timbl 85: </PRE>
2.38 frystyk 86: <P>
87: If you don't expect any return values then <CODE>reply</CODE> can be NULL.
88: The return value of the callback function can be used to indicate confirmation
89: on a prompt (Yes or No).
2.55 ! frystyk 90: <H2>
! 91: <A NAME="String">User Prompts and Questions</A>
! 92: </H2>
2.38 frystyk 93: <P>
94: This is an enumerated list of messages that can be converted into a string
2.55 ! frystyk 95: table etc. See the <A HREF="HTDialog.html#Prompt">HTDialog module</A> for
! 96: default initialization of these strings.
2.15 frystyk 97: <PRE>
2.32 frystyk 98: typedef enum _HTAlertMsg {
99: HT_MSG_NULL = -1,
100: HT_MSG_UID = 0,
2.43 frystyk 101: HT_MSG_PROXY_UID,
102: HT_MSG_FTP_UID,
2.32 frystyk 103: HT_MSG_PW,
104: HT_MSG_FILENAME,
105: HT_MSG_ACCOUNT,
106: HT_MSG_METHOD,
107: HT_MSG_MOVED,
108: HT_MSG_RULES,
2.39 frystyk 109: HT_MSG_FILE_REPLACE,
110: HT_MSG_RETRY_AUTHENTICATION,
2.41 frystyk 111: HT_MSG_RETRY_PROXY_AUTH,
2.40 frystyk 112: HT_MSG_REDO,
113: HT_MSG_BIG_PUT,
114: HT_MSG_SOURCE_MOVED,
115: HT_MSG_DESTINATION_MOVED,
2.41 frystyk 116: HT_MSG_REDIRECTION,
2.47 frystyk 117: HT_MSG_PROXY,
2.48 frystyk 118: HT_MSG_CACHE_LOCK,
2.55 ! frystyk 119: HT_MSG_ACCEPT_COOKIE,
2.32 frystyk 120: HT_MSG_ELEMENTS /* This MUST be the last element */
121: } HTAlertMsg;
2.15 frystyk 122: </PRE>
2.38 frystyk 123: <H2>
2.55 ! frystyk 124: <A NAME="Enable">Enable or Disable Messages</A>
2.38 frystyk 125: </H2>
126: <P>
127: If you really don't want the library to prompt for anything at all then enable
128: this constant. The default value is <EM>Interactive</EM>.
2.32 frystyk 129: <PRE>
130: extern void HTAlert_setInteractive (BOOL interative);
131: extern BOOL HTAlert_interactive (void);
2.15 frystyk 132: </PRE>
2.38 frystyk 133: <H2>
2.55 ! frystyk 134: <A NAME="Creation">Creation and Deletion Methods</A>
2.38 frystyk 135: </H2>
136: <P>
137: Message methods are registered in lists. By default a list is not enabled
138: before you assign it as being <I><A HREF="#active">active</A></I>. This allows
139: the application to maintain multiple lists of message handlers which can
140: be swapped in and out as neeeded.
141: <H3>
142: Add a Callback Function
143: </H3>
144: <P>
145: Register a call back function that is to be called when generating messages,
146: dialog, prompts, progress reports etc. The opcode signifies which call back
147: function to call depending of the type of the message. Opcode can be any
148: combination of the bitflags defined by <CODE>HTAlertOpcode</CODE>. If you
149: register one callback for <CODE>HT_A_PROGRESS </CODE>then this will get called
150: on all progress notifications.
2.15 frystyk 151: <PRE>
2.32 frystyk 152: extern BOOL HTAlertCall_add (HTList * list, HTAlertCallback * cbf,
153: HTAlertOpcode opcode);
2.15 frystyk 154: </PRE>
2.38 frystyk 155: <H3>
156: Delete a Callback function
157: </H3>
158: <P>
2.32 frystyk 159: Unregister a call back function from a list
2.8 luotonen 160: <PRE>
2.32 frystyk 161: extern BOOL HTAlertCall_delete (HTList * list, HTAlertCallback * cbf);
2.15 frystyk 162: </PRE>
2.38 frystyk 163: <H3>
2.51 frystyk 164: Delete all Callbacks With this Opcode
165: </H3>
166: <P>
167: Unregister all handlers registered for a given opcode.
168: <PRE>
169: extern BOOL HTAlertCall_deleteOpcode (HTList * list, HTAlertOpcode opcode);
170: </PRE>
171: <H3>
2.38 frystyk 172: Delete a list of Callback Functions
173: </H3>
174: <P>
2.32 frystyk 175: Unregisters all call back functions
176: <PRE>
177: extern BOOL HTAlertCall_deleteAll (HTList * list);
178: </PRE>
2.38 frystyk 179: <H3>
180: Find a Callback Function
181: </H3>
182: <P>
183: Finds a callback function corresponding to the opcode. If none has been
184: registered then NULL is returned.
2.6 timbl 185: <PRE>
2.32 frystyk 186: extern HTAlertCallback * HTAlertCall_find(HTList * list, HTAlertOpcode opcode);
2.6 timbl 187: </PRE>
2.38 frystyk 188: <H2>
189: The Reply Object
190: </H2>
191: <P>
192: The reply object is used for communicating input from the <I>user</I> back
193: to the Library. This is only required to use when for example the user is
194: prompted for a file name etc. You can find several examples on how to use
195: this in the <A HREF="HTDialog.html">default message and dialog module</A>
196: provided together with the Library.
197: <PRE>extern HTAlertPar * HTAlert_newReply (void);
2.32 frystyk 198: extern void HTAlert_deleteReply (HTAlertPar * old);
199: </PRE>
2.38 frystyk 200: <H3>
201: Handle the Reply Message
202: </H3>
203: <P>
204: These methods provide the API for handling the reply message. There are two
205: ways of assigning a message to the reply message - either by copying the
206: buffer or by reusing the same buffer. In the latter case, the caller must
207: make sure <B>not</B> to free the reply message before it has been used.
2.34 frystyk 208: <PRE>
2.35 frystyk 209: extern BOOL HTAlert_setReplyMessage (HTAlertPar * me, const char *message);
2.34 frystyk 210: extern BOOL HTAlert_assignReplyMessage (HTAlertPar * me, char * message);
211: </PRE>
2.38 frystyk 212: <P>
2.34 frystyk 213: You can get the data back again by using this method:
2.32 frystyk 214: <PRE>
215: extern char * HTAlert_replyMessage (HTAlertPar * me);
2.34 frystyk 216: </PRE>
217: <PRE>
2.32 frystyk 218: extern char * HTAlert_replySecret (HTAlertPar * me);
2.35 frystyk 219: extern BOOL HTAlert_setReplySecret (HTAlertPar * me, const char * secret);
2.6 timbl 220:
2.32 frystyk 221: extern void * HTAlert_replyOutput (HTAlertPar * me);
222: extern BOOL HTAlert_setReplyOutput (HTAlertPar * me, void * output);
2.17 frystyk 223: </PRE>
2.38 frystyk 224: <H2>
225: <A NAME="active">Active set of Callback Functions</A>
226: </H2>
227: <P>
228: A list can be assigned as being active in which case it is <I>visible</I>
2.51 frystyk 229: for libwww by assigning the list as the <I>global alert list</I>. Libwww
230: does not know about inactive lists of alert handlers.
2.32 frystyk 231: <PRE>
232: extern void HTAlert_setGlobal (HTList * list);
233: extern HTList * HTAlert_global (void);
234: </PRE>
2.51 frystyk 235: <H3>
236: Global Alert List Methods
237: </H3>
2.38 frystyk 238: <P>
2.51 frystyk 239: You can assign a callback directly to the global list in which case it becomes
240: immediately available to libwww. In this case you do not need to worry about
241: creating the list - it will be created as well as deleted automatically.
242: <H4>
243: Add an Alert Handler
244: </H4>
245: <PRE>
246: extern BOOL HTAlert_add (HTAlertCallback * cbf, HTAlertOpcode opcode);
247: </PRE>
248: <H4>
249: Delete an Alert Handler
250: </H4>
251: <P>
252: You can either delete a handler by referring to its address or to the opcode
253: that it has been registered for.
254: <PRE>
255: extern BOOL HTAlert_delete (HTAlertCallback * cbf);
256: extern BOOL HTAlert_deleteOpcode (HTAlertOpcode opcode);
257: </PRE>
258: <H4>
259: Delete all Alert Handlers
260: </H4>
2.17 frystyk 261: <PRE>
2.49 frystyk 262: extern BOOL HTAlert_deleteAll (void);
2.51 frystyk 263: </PRE>
264: <H4>
265: Find an Alert Handler
266: </H4>
267: <PRE>
2.32 frystyk 268: extern HTAlertCallback * HTAlert_find (HTAlertOpcode opcode);
269: </PRE>
270: <PRE>
2.12 frystyk 271: #endif
272: </PRE>
2.38 frystyk 273: <P>
274: <HR>
2.37 frystyk 275: <ADDRESS>
2.55 ! frystyk 276: @(#) $Id: HTAlert.html,v 2.54 1998/11/20 15:53:48 frystyk Exp $
2.37 frystyk 277: </ADDRESS>
2.38 frystyk 278: </BODY></HTML>
Webmaster
![[BACK]](/cvsweb/icons/back.gif){kind=icon}
Return to HTAlert.html CVS log ![[TXT]](/cvsweb/icons/text.gif){kind=icon}
![[DIR]](/cvsweb/icons/dir.gif){kind=icon}
Up to [Public] / libwww / Library / src