1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/*********************************************************
* Copyright (C) 1998 VMware, Inc. All rights reserved.
*
* This program is free software; you can redistribute it and/or modify it
* under the terms of the GNU Lesser General Public License as published
* by the Free Software Foundation version 2.1 and no later version.
*
* This program is distributed in the hope that it will be useful, but
* WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
* or FITNESS FOR A PARTICULAR PURPOSE. See the Lesser GNU General Public
* License for more details.
*
* You should have received a copy of the GNU Lesser General Public License
* along with this program; if not, write to the Free Software Foundation, Inc.,
* 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
*
*********************************************************/
#ifndef _HGFS_SERVER_H_
#define _HGFS_SERVER_H_
#include "hgfs.h" /* for HGFS_PACKET_MAX */
#include "dbllnklst.h"
/*
* Function used for sending updates of server state to the manager.
* Passed by the caller at session connect time.
*/
typedef void
HgfsServerStateLoggerFunc(void *data, // IN
uint64 cookie); // IN
typedef struct HgfsServerStateLogger {
HgfsServerStateLoggerFunc *logger; // logger callback
void *loggerData; // logger callback private data
} HgfsServerStateLogger;
/*
* Function used for sending replies to the client for a session.
* Passed by the caller at session connect time.
*/
/*
* Send flags.
*
* Contains a bitwise OR of a combination of the following flags:
* HGFS_SEND_CAN_DELAY - directs the channel to try and optimize
* otherwise it will send the data immediately.
* HGFS_SEND_NO_COMPLETE - directs the channel to not call the
* send complete callback. Caller does not call completion notification
* callback, for example to free buffers.
*/
typedef uint32 HgfsSendFlags;
#define HGFS_SEND_CAN_DELAY (1 << 0)
#define HGFS_SEND_NO_COMPLETE (1 << 1)
/*
* Receive flags.
*
* Contains a bitwise OR of a combination of the following flags:
* HGFS_RECEIVE_CAN_DELAY - directs the server to handle the message
* asynchronously.
*/
typedef uint32 HgfsReceiveFlags;
#define HGFS_RECEIVE_CAN_DELAY (1 << 0)
typedef Bool
HgfsSessionSendFunc(void *opaqueSession, // IN
char *buffer, // IN
size_t bufferLen, // IN
HgfsSendFlags flags); // IN
typedef struct HgfsServerSessionCallbacks {
Bool (*connect)(void *, HgfsSessionSendFunc *, void **);
void (*disconnect)(void *);
void (*close)(void *);
void (*receive)(char const *,size_t, void *, HgfsReceiveFlags);
void (*invalidateObjects)(void *, DblLnkLst_Links *);
void (*sendComplete)(void *, char *);
} HgfsServerSessionCallbacks;
Bool HgfsServer_InitState(HgfsServerSessionCallbacks **, HgfsServerStateLogger *);
void HgfsServer_ExitState(void);
uint32 HgfsServer_GetHandleCounter(void);
void HgfsServer_SetHandleCounter(uint32 newHandleCounter);
#ifdef VMX86_TOOLS
void HgfsServer_ProcessPacket(char const *packetIn,
char *packetOut,
size_t *packetSize,
HgfsReceiveFlags flags);
#endif
/*
* Function pointers used for getting names in HgfsServerGetDents
*
* Functions of this type are expected to return a NUL terminated
* string and the length of that string.
*/
typedef Bool
HgfsGetNameFunc(void *data, // IN
char const **name, // OUT
size_t *len, // OUT
Bool *done); // OUT
/*
* Associated setup and cleanup function types, which should be called
* before and after (respectively) HgfsGetNameFunc.
*/
typedef void *
HgfsInitFunc(void);
typedef Bool
HgfsCleanupFunc(void *); // IN
/*
* Function used for invalidating nodes and searches that fall outside of a
* share when the list of shares changes.
*/
typedef void
HgfsInvalidateObjectsFunc(DblLnkLst_Links *shares); // IN
#endif // _HGFS_SERVER_H_
|
