[thirdparty/cups.git] / scheduler / dirsvc.h

/*
 * "$Id: dirsvc.h 5020 2006-01-28 13:36:15Z mike $"
 *
 *   Directory services definitions for the Common UNIX Printing System
 *   (CUPS) scheduler.
 *
 *   Copyright 1997-2005 by Easy Software Products, all rights reserved.
 *
 *   These coded instructions, statements, and computer programs are the
 *   property of Easy Software Products and are protected by Federal
 *   copyright law.  Distribution and use rights are outlined in the file
 *   "LICENSE.txt" which should have been included with this file.  If this
 *   file is missing or damaged please contact Easy Software Products
 *   at:
 *
 *       Attn: CUPS Licensing Information
 *       Easy Software Products
 *       44141 Airport View Drive, Suite 204
 *       Hollywood, Maryland 20636 USA
 *
 *       Voice: (301) 373-9600
 *       EMail: cups-info@cups.org
 *         WWW: http://www.cups.org
 */

/*
 * Include necessary headers...
 */

#ifdef HAVE_LIBSLP
#  include <slp.h>
#endif /* HAVE_LIBSLP */


/*
 * Browse protocols...
 */

#define BROWSE_CUPS	1		/* CUPS */
#define	BROWSE_SLP	2		/* SLPv2 */
#define BROWSE_LDAP	4		/* LDAP (not supported yet) */
#define BROWSE_DNSSD	8		/* DNS Service Discovery aka Bonjour */
#define BROWSE_ALL	15		/* All protocols */


/*
 * Browse address...
 */

typedef struct
{
  char			iface[32];	/* Destination interface */
  http_addr_t		to;		/* Destination address */
} cupsd_dirsvc_addr_t;


/*
 * Relay structure...
 */

typedef struct
{
  cupsd_authmask_t	from;		/* Source address/name mask */
  http_addr_t		to;		/* Destination address */
} cupsd_dirsvc_relay_t;


/*
 * Polling structure...
 */

typedef struct
{
  char			hostname[64];	/* Hostname (actually, IP address) */
  int			port;		/* Port number */
  int			pid;		/* Current poll server PID */
} cupsd_dirsvc_poll_t;


/*
 * Globals...
 */

VAR int			Browsing	VALUE(TRUE),
					/* Whether or not browsing is enabled */
			BrowseLocalProtocols
					VALUE(BROWSE_ALL),
					/* Protocols to support for local printers */
			BrowseRemoteProtocols
					VALUE(BROWSE_ALL),
					/* Protocols to support for remote printers */
			BrowseShortNames VALUE(TRUE),
					/* Short names for remote printers? */
			BrowseSocket	VALUE(-1),
					/* Socket for browsing */
			BrowsePort	VALUE(IPP_PORT),
					/* Port number for broadcasts */
			BrowseInterval	VALUE(DEFAULT_INTERVAL),
					/* Broadcast interval in seconds */
			BrowseTimeout	VALUE(DEFAULT_TIMEOUT),
					/* Time out for printers in seconds */
			NumBrowsers	VALUE(0);
					/* Number of broadcast addresses */
VAR char		*BrowseLocalOptions
					VALUE(NULL),
					/* Options to add to local printer URIs */
			*BrowseRemoteOptions
					VALUE(NULL);
					/* Options to add to remote printer URIs */
VAR cupsd_dirsvc_addr_t	*Browsers	VALUE(NULL);
					/* Broadcast addresses */
VAR cupsd_location_t	*BrowseACL	VALUE(NULL);
					/* Browser access control list */
VAR cupsd_printer_t	*BrowseNext	VALUE(NULL);
					/* Next class/printer to broadcast */
VAR int			NumRelays	VALUE(0);
					/* Number of broadcast relays */
VAR cupsd_dirsvc_relay_t *Relays	VALUE(NULL);
					/* Broadcast relays */
VAR int			NumPolled	VALUE(0);
					/* Number of polled servers */
VAR cupsd_dirsvc_poll_t	*Polled		VALUE(NULL);
					/* Polled servers */
VAR int			PollPipe	VALUE(0);
					/* Status pipe for pollers */
VAR cupsd_statbuf_t	*PollStatusBuffer VALUE(NULL);
					/* Status buffer for pollers */

#ifdef HAVE_LIBSLP
VAR SLPHandle		BrowseSLPHandle	VALUE(NULL);
					/* SLP API handle */
VAR time_t		BrowseSLPRefresh VALUE(0);
					/* Next SLP refresh time */
#endif /* HAVE_LIBSLP */


/*
 * Prototypes...
 */

extern void	cupsdLoadRemoteCache(void);
extern void	cupsdProcessBrowseData(const char *uri, cups_ptype_t type,
		                       ipp_pstate_t state, const char *location,
				       const char *info, const char *make_model,
				       int num_attrs, cups_option_t *attrs);
extern void	cupsdProcessImplicitClasses(void);
extern void	cupsdSaveRemoteCache(void);
extern void	cupsdSendBrowseDelete(cupsd_printer_t *p);
extern void	cupsdSendBrowseList(void);
extern void	cupsdSendCUPSBrowse(cupsd_printer_t *p);
extern void	cupsdSendSLPBrowse(cupsd_printer_t *p);
extern void	cupsdStartBrowsing(void);
extern void	cupsdStartPolling(void);
extern void	cupsdStopBrowsing(void);
extern void	cupsdStopPolling(void);
extern void	cupsdUpdateCUPSBrowse(void);
extern void	cupsdUpdatePolling(void);
extern void	cupsdUpdateSLPBrowse(void);


/*
 * End of "$Id: dirsvc.h 5020 2006-01-28 13:36:15Z mike $".
 */
Commit	Line	Data
ef416fc2	1	/*
a4d04587	2	* "$Id: dirsvc.h 5020 2006-01-28 13:36:15Z mike $"
ef416fc2	3	*
	4	* Directory services definitions for the Common UNIX Printing System
	5	* (CUPS) scheduler.
	6	*
	7	* Copyright 1997-2005 by Easy Software Products, all rights reserved.
	8	*
	9	* These coded instructions, statements, and computer programs are the
	10	* property of Easy Software Products and are protected by Federal
	11	* copyright law. Distribution and use rights are outlined in the file
	12	* "LICENSE.txt" which should have been included with this file. If this
	13	* file is missing or damaged please contact Easy Software Products
	14	* at:
	15	*
	16	* Attn: CUPS Licensing Information
	17	* Easy Software Products
	18	* 44141 Airport View Drive, Suite 204
	19	* Hollywood, Maryland 20636 USA
	20	*
	21	* Voice: (301) 373-9600
	22	* EMail: cups-info@cups.org
	23	* WWW: http://www.cups.org
	24	*/
	25
	26	/*
	27	* Include necessary headers...
	28	*/
	29
	30	#ifdef HAVE_LIBSLP
	31	# include <slp.h>
	32	#endif /* HAVE_LIBSLP */
	33
	34
	35	/*
	36	* Browse protocols...
	37	*/
	38
	39	#define BROWSE_CUPS 1 /* CUPS */
	40	#define BROWSE_SLP 2 /* SLPv2 */
	41	#define BROWSE_LDAP 4 /* LDAP (not supported yet) */
a4d04587	42	#define BROWSE_DNSSD 8 /* DNS Service Discovery aka Bonjour */
a4d04587	43	#define BROWSE_ALL 15 /* All protocols */
ef416fc2	44
	45
	46	/*
	47	* Browse address...
	48	*/
	49
	50	typedef struct
	51	{
	52	char iface[32]; /* Destination interface */
	53	http_addr_t to; /* Destination address */
	54	} cupsd_dirsvc_addr_t;
	55
	56
	57	/*
	58	* Relay structure...
	59	*/
	60
	61	typedef struct
	62	{
	63	cupsd_authmask_t from; /* Source address/name mask */
	64	http_addr_t to; /* Destination address */
	65	} cupsd_dirsvc_relay_t;
	66
	67
	68	/*
	69	* Polling structure...
	70	*/
	71
	72	typedef struct
	73	{
	74	char hostname[64]; /* Hostname (actually, IP address) */
	75	int port; /* Port number */
	76	int pid; /* Current poll server PID */
	77	} cupsd_dirsvc_poll_t;
	78
	79
	80	/*
	81	* Globals...
	82	*/
	83
	84	VAR int Browsing VALUE(TRUE),
	85	/* Whether or not browsing is enabled */
	86	BrowseLocalProtocols
	87	VALUE(BROWSE_ALL),
	88	/* Protocols to support for local printers */
	89	BrowseRemoteProtocols
	90	VALUE(BROWSE_ALL),
	91	/* Protocols to support for remote printers */
	92	BrowseShortNames VALUE(TRUE),
	93	/* Short names for remote printers? */
	94	BrowseSocket VALUE(-1),
	95	/* Socket for browsing */
	96	BrowsePort VALUE(IPP_PORT),
	97	/* Port number for broadcasts */
	98	BrowseInterval VALUE(DEFAULT_INTERVAL),
	99	/* Broadcast interval in seconds */
	100	BrowseTimeout VALUE(DEFAULT_TIMEOUT),
	101	/* Time out for printers in seconds */
	102	NumBrowsers VALUE(0);
	103	/* Number of broadcast addresses */
	104	VAR char *BrowseLocalOptions
	105	VALUE(NULL),
	106	/* Options to add to local printer URIs */
	107	*BrowseRemoteOptions
108	VALUE(NULL);
109	/* Options to add to remote printer URIs */
110	VAR cupsd_dirsvc_addr_t *Browsers VALUE(NULL);
111	/* Broadcast addresses */
112	VAR cupsd_location_t *BrowseACL VALUE(NULL);
113	/* Browser access control list */
114	VAR cupsd_printer_t *BrowseNext VALUE(NULL);
115	/* Next class/printer to broadcast */
116	VAR int NumRelays VALUE(0);
117	/* Number of broadcast relays */
118	VAR cupsd_dirsvc_relay_t *Relays VALUE(NULL);
119	/* Broadcast relays */
120	VAR int NumPolled VALUE(0);
121	/* Number of polled servers */
122	VAR cupsd_dirsvc_poll_t *Polled VALUE(NULL);
123	/* Polled servers */
124	VAR int PollPipe VALUE(0);
125	/* Status pipe for pollers */
126	VAR cupsd_statbuf_t *PollStatusBuffer VALUE(NULL);
127	/* Status buffer for pollers */
128
129	#ifdef HAVE_LIBSLP
130	VAR SLPHandle BrowseSLPHandle VALUE(NULL);
131	/* SLP API handle */
132	VAR time_t BrowseSLPRefresh VALUE(0);
133	/* Next SLP refresh time */
134	#endif /* HAVE_LIBSLP */
135
136
137	/*
138	* Prototypes...
139	*/
140
141	extern void cupsdLoadRemoteCache(void);
142	extern void cupsdProcessBrowseData(const char *uri, cups_ptype_t type,
143	ipp_pstate_t state, const char *location,
144	const char info, const char make_model,
145	int num_attrs, cups_option_t *attrs);
146	extern void cupsdProcessImplicitClasses(void);
147	extern void cupsdSaveRemoteCache(void);
148	extern void cupsdSendBrowseDelete(cupsd_printer_t *p);
149	extern void cupsdSendBrowseList(void);
150	extern void cupsdSendCUPSBrowse(cupsd_printer_t *p);
151	extern void cupsdSendSLPBrowse(cupsd_printer_t *p);
152	extern void cupsdStartBrowsing(void);
153	extern void cupsdStartPolling(void);
154	extern void cupsdStopBrowsing(void);
155	extern void cupsdStopPolling(void);
156	extern void cupsdUpdateCUPSBrowse(void);
157	extern void cupsdUpdatePolling(void);
158	extern void cupsdUpdateSLPBrowse(void);
159
160
161	/*
a4d04587	162	* End of "$Id: dirsvc.h 5020 2006-01-28 13:36:15Z mike $".
ef416fc2	163	*/