Edit File by line

/******************************************************************************

[0] Fix | Delete

[1] Fix | Delete

[2] Fix | Delete

[3] Fix | Delete

[4] Fix | Delete

Permission to use, copy, modify, distribute, and sell this software and its

[5] Fix | Delete

documentation for any purpose is hereby granted without fee, provided that

[6] Fix | Delete

the above copyright notice appear in all copies and that both that

[7] Fix | Delete

[8] Fix | Delete

documentation.

[9] Fix | Delete

[10] Fix | Delete

The above copyright notice and this permission notice shall be included in

[11] Fix | Delete

all copies or substantial portions of the Software.

[12] Fix | Delete

[13] Fix | Delete

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR

[14] Fix | Delete

IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,

[15] Fix | Delete

FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE

[16] Fix | Delete

OPEN GROUP BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN

[17] Fix | Delete

AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN

[18] Fix | Delete

CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

[19] Fix | Delete

[20] Fix | Delete

Except as contained in this notice, the name of The Open Group shall not be

[21] Fix | Delete

used in advertising or otherwise to promote the sale, use or other dealings

[22] Fix | Delete

in this Software without prior written authorization from The Open Group.

[23] Fix | Delete

[24] Fix | Delete

Author: Ralph Mor, X Consortium

[25] Fix | Delete

******************************************************************************/

[26] Fix | Delete

[27] Fix | Delete

#ifndef _ICECONN_H_

[28] Fix | Delete

#define _ICECONN_H_

[29] Fix | Delete

[30] Fix | Delete

#include <X11/ICE/ICElib.h>

[31] Fix | Delete

[32] Fix | Delete

[33] Fix | Delete

* Data structures for ICE connection object

[34] Fix | Delete

[35] Fix | Delete

[36] Fix | Delete

typedef struct _IceSavedReplyWait {

[37] Fix | Delete

IceReplyWaitInfo *reply_wait;

[38] Fix | Delete

Bool reply_ready;

[39] Fix | Delete

struct _IceSavedReplyWait *next;

[40] Fix | Delete

} _IceSavedReplyWait;

[41] Fix | Delete

[42] Fix | Delete

typedef struct _IcePingWait {

[43] Fix | Delete

IcePingReplyProc ping_reply_proc;

[44] Fix | Delete

IcePointer client_data;

[45] Fix | Delete

struct _IcePingWait *next;

[46] Fix | Delete

} _IcePingWait;

[47] Fix | Delete

[48] Fix | Delete

typedef struct {

[49] Fix | Delete

char *vendor;

[50] Fix | Delete

char *release;

[51] Fix | Delete

int version_count;

[52] Fix | Delete

IcePoVersionRec *version_recs;

[53] Fix | Delete

int auth_count;

[54] Fix | Delete

char **auth_names;

[55] Fix | Delete

IcePoAuthProc *auth_procs;

[56] Fix | Delete

IceIOErrorProc io_error_proc;

[57] Fix | Delete

} _IcePoProtocol;

[58] Fix | Delete

[59] Fix | Delete

typedef struct {

[60] Fix | Delete

char *vendor;

[61] Fix | Delete

char *release;

[62] Fix | Delete

int version_count;

[63] Fix | Delete

IcePaVersionRec *version_recs;

[64] Fix | Delete

IceProtocolSetupProc protocol_setup_proc;

[65] Fix | Delete

IceProtocolActivateProc protocol_activate_proc;

[66] Fix | Delete

int auth_count;

[67] Fix | Delete

char **auth_names;

[68] Fix | Delete

IcePaAuthProc *auth_procs;

[69] Fix | Delete

IceHostBasedAuthProc host_based_auth_proc;

[70] Fix | Delete

IceIOErrorProc io_error_proc;

[71] Fix | Delete

} _IcePaProtocol;

[72] Fix | Delete

[73] Fix | Delete

typedef struct {

[74] Fix | Delete

char *protocol_name;

[75] Fix | Delete

_IcePoProtocol *orig_client;

[76] Fix | Delete

_IcePaProtocol *accept_client;

[77] Fix | Delete

} _IceProtocol;

[78] Fix | Delete

[79] Fix | Delete

typedef struct {

[80] Fix | Delete

Bool in_use;

[81] Fix | Delete

int my_opcode;

[82] Fix | Delete

_IceProtocol *protocol;

[83] Fix | Delete

IcePointer client_data;

[84] Fix | Delete

Bool accept_flag;

[85] Fix | Delete

union {

[86] Fix | Delete

IcePaProcessMsgProc accept_client;

[87] Fix | Delete

IcePoProcessMsgProc orig_client;

[88] Fix | Delete

} process_msg_proc;

[89] Fix | Delete

} _IceProcessMsgInfo;

[90] Fix | Delete

[91] Fix | Delete

typedef struct {

[92] Fix | Delete

int his_version_index;

[93] Fix | Delete

int my_version_index;

[94] Fix | Delete

char *his_vendor;

[95] Fix | Delete

char *his_release;

[96] Fix | Delete

char my_auth_index;

[97] Fix | Delete

IcePointer my_auth_state;

[98] Fix | Delete

Bool must_authenticate;

[99] Fix | Delete

} _IceConnectToMeInfo;

[100] Fix | Delete

[101] Fix | Delete

typedef struct {

[102] Fix | Delete

int his_opcode;

[103] Fix | Delete

int my_opcode;

[104] Fix | Delete

int his_version_index;

[105] Fix | Delete

int my_version_index;

[106] Fix | Delete

char *his_vendor;

[107] Fix | Delete

char *his_release;

[108] Fix | Delete

char my_auth_index;

[109] Fix | Delete

IcePointer my_auth_state;

[110] Fix | Delete

Bool must_authenticate;

[111] Fix | Delete

} _IceProtoSetupToMeInfo;

[112] Fix | Delete

[113] Fix | Delete

typedef struct {

[114] Fix | Delete

Bool auth_active;

[115] Fix | Delete

char my_auth_index;

[116] Fix | Delete

IcePointer my_auth_state;

[117] Fix | Delete

} _IceConnectToYouInfo;

[118] Fix | Delete

[119] Fix | Delete

typedef struct {

[120] Fix | Delete

int my_opcode;

[121] Fix | Delete

int my_auth_count;

[122] Fix | Delete

int *my_auth_indices;

[123] Fix | Delete

Bool auth_active;

[124] Fix | Delete

char my_auth_index;

[125] Fix | Delete

IcePointer my_auth_state;

[126] Fix | Delete

} _IceProtoSetupToYouInfo;

[127] Fix | Delete

[128] Fix | Delete

[129] Fix | Delete

struct _IceConn {

[130] Fix | Delete

[131] Fix | Delete

unsigned int io_ok : 1; /* did an IO error occur? */

[132] Fix | Delete

unsigned int swap : 1; /* do we need to swap on reads? */

[133] Fix | Delete

unsigned int waiting_for_byteorder : 1; /* waiting for a ByteOrder msg? */

[134] Fix | Delete

unsigned int skip_want_to_close : 1; /* avoid shutdown negotiation? */

[135] Fix | Delete

unsigned int want_to_close : 1; /* did we send a WantToClose? */

[136] Fix | Delete

unsigned int free_asap : 1; /* free as soon as possible */

[137] Fix | Delete

unsigned int unused1 : 2; /* future use */

[138] Fix | Delete

unsigned int unused2 : 8; /* future use */

[139] Fix | Delete

[140] Fix | Delete

IceConnectStatus connection_status; /* pending, accepted, rejected */

[141] Fix | Delete

[142] Fix | Delete

unsigned char my_ice_version_index; /* which version are we using? */

[143] Fix | Delete

[144] Fix | Delete

struct _XtransConnInfo *trans_conn; /* transport connection object */

[145] Fix | Delete

unsigned long send_sequence; /* Sequence # of last msg sent */

[146] Fix | Delete

unsigned long receive_sequence; /* Sequence # of last msg received */

[147] Fix | Delete

[148] Fix | Delete

char *connection_string; /* network connection string */

[149] Fix | Delete

char *vendor; /* other client's vendor */

[150] Fix | Delete

char *release; /* other client's release */

[151] Fix | Delete

[152] Fix | Delete

char *inbuf; /* Input buffer starting address */

[153] Fix | Delete

char *inbufptr; /* Input buffer index pointer */

[154] Fix | Delete

char *inbufmax; /* Input buffer maximum+1 address */

[155] Fix | Delete

[156] Fix | Delete

char *outbuf; /* Output buffer starting address */

[157] Fix | Delete

char *outbufptr; /* Output buffer index pointer */

[158] Fix | Delete

char *outbufmax; /* Output buffer maximum+1 address */

[159] Fix | Delete

[160] Fix | Delete

char *scratch; /* scratch buffer */

[161] Fix | Delete

unsigned long scratch_size; /* scratch size */

[162] Fix | Delete

[163] Fix | Delete

int dispatch_level; /* IceProcessMessages dispatch level */

[164] Fix | Delete

[165] Fix | Delete

IcePointer context; /* context associated with caller

[166] Fix | Delete

of IceOpenConnection */

[167] Fix | Delete

[168] Fix | Delete

[169] Fix | Delete

* Before we read a message, the major opcode of the message must be

[170] Fix | Delete

* mapped to our corresponding major opcode (the two clients can use

[171] Fix | Delete

* different opcodes for the same protocol). In order to save space,

[172] Fix | Delete

* we keep track of the mininum and maximum major opcodes used by the

[173] Fix | Delete

* other client. To get the information on how to process this message,

[174] Fix | Delete

* we do the following...

[175] Fix | Delete

[176] Fix | Delete

* processMsgInfo = iceConn->process_msg_info[

[177] Fix | Delete

* message->majorOpcode - iceConn->his_min_opcode]

[178] Fix | Delete

[179] Fix | Delete

* Note that the number of elements in the iceConn->process_msg_info

[180] Fix | Delete

* array is always (iceConn->his_max_opcode - iceConn->his_min_opcode + 1).

[181] Fix | Delete

* We check process_msg_info->in_use to see if the opcode is being used.

[182] Fix | Delete

[183] Fix | Delete

[184] Fix | Delete

_IceProcessMsgInfo *process_msg_info;

[185] Fix | Delete

char his_min_opcode; /* [1..255] */

[186] Fix | Delete

char his_max_opcode; /* [1..255] */

[187] Fix | Delete

[188] Fix | Delete

[189] Fix | Delete

[190] Fix | Delete

* Number of times this iceConn was returned in IceOpenConnection

[191] Fix | Delete

* or IceAcceptConnection.

[192] Fix | Delete

[193] Fix | Delete

[194] Fix | Delete

unsigned char open_ref_count;

[195] Fix | Delete

[196] Fix | Delete

[197] Fix | Delete

[198] Fix | Delete

* Number of active protocols.

[199] Fix | Delete

[200] Fix | Delete

[201] Fix | Delete

unsigned char proto_ref_count;

[202] Fix | Delete

[203] Fix | Delete

[204] Fix | Delete

[205] Fix | Delete

* If this ICE connection was created with IceAcceptConnection,

[206] Fix | Delete

* the listen_obj field is set to the listen object. Otherwise,

[207] Fix | Delete

* the listen_obj field is NULL.

[208] Fix | Delete

[209] Fix | Delete

[210] Fix | Delete

IceListenObj listen_obj;

[211] Fix | Delete

[212] Fix | Delete

[213] Fix | Delete

[214] Fix | Delete

[215] Fix | Delete

[216] Fix | Delete

* We need to keep track of all the replies we're waiting for.

[217] Fix | Delete

* Check the comments in process.c for how this works.

[218] Fix | Delete

[219] Fix | Delete

[220] Fix | Delete

_IceSavedReplyWait *saved_reply_waits;

[221] Fix | Delete

[222] Fix | Delete

[223] Fix | Delete

[224] Fix | Delete

* We keep track of all Pings sent from the client. When the Ping reply

[225] Fix | Delete

* arrives, we remove it from the list.

[226] Fix | Delete

[227] Fix | Delete

[228] Fix | Delete

_IcePingWait *ping_waits;

[229] Fix | Delete

[230] Fix | Delete

[231] Fix | Delete

[232] Fix | Delete

* Some state for a client doing a Connection/Protocol Setup

[233] Fix | Delete

[234] Fix | Delete

[235] Fix | Delete

_IceConnectToYouInfo *connect_to_you;

[236] Fix | Delete

_IceProtoSetupToYouInfo *protosetup_to_you;

[237] Fix | Delete

[238] Fix | Delete

[239] Fix | Delete

[240] Fix | Delete

* Some state for a client receiving a Connection/Protocol Setup

[241] Fix | Delete

[242] Fix | Delete

[243] Fix | Delete

_IceConnectToMeInfo *connect_to_me;

[244] Fix | Delete

_IceProtoSetupToMeInfo *protosetup_to_me;

[245] Fix | Delete

[246] Fix | Delete

};

[247] Fix | Delete

[248] Fix | Delete

#endif /* _ICECONN_H_ */

[249] Fix | Delete

[250] Fix | Delete