Release 20040408.
[wine/multimedia.git] / server / file.h
blob159b630aa2d44b782db711f7cf7b4b93a944b764
1 /*
2 * Server-side file definitions
4 * Copyright (C) 2003 Alexandre Julliard
6 * This library is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU Lesser General Public
8 * License as published by the Free Software Foundation; either
9 * version 2.1 of the License, or (at your option) any later version.
11 * This library is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
14 * Lesser General Public License for more details.
16 * You should have received a copy of the GNU Lesser General Public
17 * License along with this library; if not, write to the Free Software
18 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
21 #ifndef __WINE_SERVER_FILE_H
22 #define __WINE_SERVER_FILE_H
24 #include "object.h"
26 struct fd;
28 typedef unsigned __int64 file_pos_t;
30 /* operations valid on file descriptor objects */
31 struct fd_ops
33 /* get the events we want to poll() for on this object */
34 int (*get_poll_events)(struct fd *);
35 /* a poll() event occurred */
36 void (*poll_event)(struct fd *,int event);
37 /* flush the object buffers */
38 int (*flush)(struct fd *, struct event **);
39 /* get file information */
40 int (*get_file_info)(struct fd *, int *flags);
41 /* queue an async operation - see register_async handler in async.c*/
42 void (*queue_async)(struct fd *, void* ptr, unsigned int status, int type, int count);
45 /* file descriptor functions */
47 extern struct fd *alloc_fd( const struct fd_ops *fd_user_ops, struct object *user );
48 extern struct fd *open_fd( struct fd *fd, const char *name, int flags, mode_t *mode,
49 unsigned int access, unsigned int sharing, const char *unlink_name );
50 extern struct fd *create_anonymous_fd( const struct fd_ops *fd_user_ops,
51 int unix_fd, struct object *user );
52 extern void *get_fd_user( struct fd *fd );
53 extern int get_unix_fd( struct fd *fd );
54 extern int is_same_file_fd( struct fd *fd1, struct fd *fd2 );
55 extern void fd_poll_event( struct fd *fd, int event );
56 extern int check_fd_events( struct fd *fd, int events );
57 extern void set_fd_events( struct fd *fd, int events );
58 extern obj_handle_t lock_fd( struct fd *fd, file_pos_t offset, file_pos_t count, int shared, int wait );
59 extern void unlock_fd( struct fd *fd, file_pos_t offset, file_pos_t count );
60 extern int flush_cached_fd( struct process *process, obj_handle_t handle );
62 extern int default_fd_add_queue( struct object *obj, struct wait_queue_entry *entry );
63 extern void default_fd_remove_queue( struct object *obj, struct wait_queue_entry *entry );
64 extern int default_fd_signaled( struct object *obj, struct thread *thread );
65 extern void default_poll_event( struct fd *fd, int event );
66 extern int no_flush( struct fd *fd, struct event **event );
67 extern int no_get_file_info( struct fd *fd, int *flags );
68 extern void no_queue_async( struct fd *fd, void* ptr, unsigned int status, int type, int count );
69 extern void main_loop(void);
71 inline static struct fd *get_obj_fd( struct object *obj ) { return obj->ops->get_fd( obj ); }
73 /* timeout functions */
75 struct timeout_user;
77 typedef void (*timeout_callback)( void *private );
79 extern struct timeout_user *add_timeout_user( struct timeval *when,
80 timeout_callback func, void *private );
81 extern void remove_timeout_user( struct timeout_user *user );
82 extern void add_timeout( struct timeval *when, int timeout );
83 /* return 1 if t1 is before t2 */
84 static inline int time_before( struct timeval *t1, struct timeval *t2 )
86 return ((t1->tv_sec < t2->tv_sec) ||
87 ((t1->tv_sec == t2->tv_sec) && (t1->tv_usec < t2->tv_usec)));
90 /* file functions */
92 extern struct file *get_file_obj( struct process *process, obj_handle_t handle,
93 unsigned int access );
94 extern int get_file_unix_fd( struct file *file );
95 extern int is_same_file( struct file *file1, struct file *file2 );
96 extern int grow_file( struct file *file, int size_high, int size_low );
97 extern struct file *create_temp_file( int access );
98 extern void file_set_error(void);
100 /* change notification functions */
102 extern void do_change_notify( int unix_fd );
103 extern void sigio_callback(void);
105 /* serial port functions */
107 extern int is_serial_fd( struct fd *fd );
108 extern struct object *create_serial( struct fd *fd, unsigned int options );
110 #endif /* __WINE_SERVER_FILE_H */