* The scheduler can now "wake up" a session to deliver async messages.

[citadel.git] / citadel / server.h

diff --git a/citadel/server.h b/citadel/server.h
index c543de3b77abafd1207ac311ef8bd5d91df40ac1..06ed9b84660d88b76125c087f6555d11ac7a362a 100644 (file)
--- a/citadel/server.h
+++ b/citadel/server.h
@@ -92,7 +92,10 @@ struct CitContext {
        char lastcmdname[5];    /* name of last command executed */
        unsigned cs_flags;      /* miscellaneous flags */
        void (*h_command_function) (void) ;     /* service command function */
+       void (*h_async_function) (void) ;       /* do async msgs function */
        int is_async;           /* Nonzero if client accepts async msgs */
+       int async_waiting;      /* Nonzero if there are async msgs waiting */
+       int input_waiting;      /* Nonzero if there is client input waiting */
 
        /* feeping creaturisms... */
        int cs_clientdev;       /* client developer ID */
@@ -129,7 +132,7 @@ struct CitContext {
        char *output_buffer;    /* hold output for one big dump */
        int buffer_len;
 
-       /* A linked list of all express messages sent to us. */
+       /* A linked list of all instant messages sent to us. */
        struct ExpressMessage *FirstExpressMessage;
        int disable_exp;        /* Set to 1 to disable incoming pages */
        int newmail;            /* Other sessions increment this */
@@ -148,10 +151,19 @@ struct CitContext {
 
 typedef struct CitContext t_context;
 
-/* Values for CitContext.state */
+/*
+ * Values for CitContext.state
+ * 
+ * A session that is doing nothing is in CON_IDLE state.  When activity
+ * is detected on the socket, it goes to CON_READY, indicating that it
+ * needs to have a worker thread bound to it.  When a thread binds to
+ * the session, it goes to CON_EXECUTING and does its thing.  When the
+ * transaction is finished, the thread sets it back to CON_IDLE and lets
+ * it go.
+ */
 enum {
        CON_IDLE,               /* This context is doing nothing */
-       CON_READY,              /* This context is ready-to-run */
+       CON_READY,              /* This context needs attention */
        CON_EXECUTING,          /* This context is bound to a thread */
 };
 
@@ -212,6 +224,7 @@ enum {
        S_PUBLIC_CLIENTS,
        S_LDAP,
        S_FLOORCACHE,
+       S_DEBUGMEMLEAKS,
        MAX_SEMAPHORES
 };
 
@@ -307,6 +320,7 @@ extern struct SessionFunctionHook *SessionHookTable;
 #define EVT_SETPASS    5       /* Setting or changing password */
 #define EVT_CMD                6       /* Called after each server command */
 #define EVT_RWHO       7       /* An RWHO command is being executed */
+#define EVT_ASYNC      8       /* Doing asynchronous messages */
 
 #define EVT_TIMER      50      /* Timer events are called once per minute
                                   and are not tied to any session */
@@ -368,7 +382,7 @@ extern struct DeleteFunctionHook *DeleteHookTable;
 
 /*
  * ExpressMessageFunctionHook extensions are used for hooks which implement
- * the sending of an express message through various channels.  Any function
+ * the sending of an instant message through various channels.  Any function
  * registered should return the number of recipients to whom the message was
  * successfully transmitted.
  */
@@ -399,6 +413,7 @@ struct ServiceFunctionHook {
        char *sockpath;
        void (*h_greeting_function) (void) ;
        void (*h_command_function) (void) ;
+       void (*h_async_function) (void) ;
        int msock;
 };
 extern struct ServiceFunctionHook *ServiceHookTable;