forked from npgsql/npgsql
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathNpgsqlMessages.cs
More file actions
153 lines (137 loc) · 5.1 KB
/
NpgsqlMessages.cs
File metadata and controls
153 lines (137 loc) · 5.1 KB
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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
// Npgsql.NpgsqlMessageTypes.cs
//
// Author:
// Dave Joyner <d4ljoyn@yahoo.com>
//
// Copyright (C) 2002 The Npgsql Development Team
// npgsql-general@gborg.postgresql.org
// http://gborg.postgresql.org/project/npgsql/projdisplay.php
//
//
// Permission to use, copy, modify, and distribute this software and its
// documentation for any purpose, without fee, and without a written
// agreement is hereby granted, provided that the above copyright notice
// and this paragraph and the following two paragraphs appear in all copies.
//
// IN NO EVENT SHALL THE NPGSQL DEVELOPMENT TEAM BE LIABLE TO ANY PARTY
// FOR DIRECT, INDIRECT, SPECIAL, INCIDENTAL, OR CONSEQUENTIAL DAMAGES,
// INCLUDING LOST PROFITS, ARISING OUT OF THE USE OF THIS SOFTWARE AND ITS
// DOCUMENTATION, EVEN IF THE NPGSQL DEVELOPMENT TEAM HAS BEEN ADVISED OF
// THE POSSIBILITY OF SUCH DAMAGE.
//
// THE NPGSQL DEVELOPMENT TEAM SPECIFICALLY DISCLAIMS ANY WARRANTIES,
// INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY
// AND FITNESS FOR A PARTICULAR PURPOSE. THE SOFTWARE PROVIDED HEREUNDER IS
// ON AN "AS IS" BASIS, AND THE NPGSQL DEVELOPMENT TEAM HAS NO OBLIGATIONS
// TO PROVIDE MAINTENANCE, SUPPORT, UPDATES, ENHANCEMENTS, OR MODIFICATIONS.
// Keep the xml comment warning quiet for this file.
using System;
using System.Diagnostics.Contracts;
using System.IO;
using System.Threading.Tasks;
namespace Npgsql
{
/// <summary>
/// Base class for all classes which represent a message sent by the PostgreSQL backend.
/// </summary>
internal abstract class BackendMessage
{
internal abstract BackendMessageCode Code { get; }
}
/// <summary>
/// Base class for all classes which represent a message sent to the PostgreSQL backend.
/// </summary>
internal abstract class FrontendMessage
{
/// <summary>
/// Called to prepare a message before writing to the buffer. Maybe through validation exceptions.
/// </summary>
internal virtual void Prepare() { }
}
/// <summary>
/// Represents a simple frontend message which is typically small and fits well within
/// the write buffer. The message is first queries for the number of bytes it requires,
/// and then writes itself out.
/// </summary>
internal abstract class SimpleFrontendMessage : FrontendMessage
{
/// <summary>
/// Returns the number of bytes needed to write this message. Can only be called after
/// <see cref="FrontendMessage.Prepare"/> has been called.
/// </summary>
internal abstract int Length { get; }
/// <summary>
/// Writes the message contents into the buffer.
/// </summary>
internal abstract void Write(NpgsqlBuffer buf);
}
/// <summary>
/// Represents an arbitrary-length message capable of flushing the buffer internally as it's
/// writing itself out.
/// </summary>
internal abstract class ChunkingFrontendMessage : FrontendMessage
{
/// <param name="buf">the buffer into which to write the message.</param>
/// <param name="directBuf">
/// an option buffer that, if returned, will be written to the server directly, bypassing our
/// NpgsqlBuffer. This is an optimization hack for bytea.
/// </param>
/// <returns>
/// Whether there was enough space in the buffer to contain the entire message.
/// If false, the buffer should be flushed and write should be called again.
/// </returns>
internal virtual bool Write(NpgsqlBuffer buf)
{
throw new NotImplementedException("Write()");
}
internal virtual bool Write(NpgsqlBuffer buf, ref DirectBuffer directBuf)
{
return Write(buf);
}
}
/// <summary>
/// For classes representing messages sent from the client to the server.
/// </summary>
internal interface IClientMessage
{
void WriteToStream(Stream outputStream);
Task WriteToStreamAsync(Stream outputStream);
}
internal enum BackendMessageCode
{
IO_ERROR = -1, // Connection broken. Mono returns -1 instead of throwing an exception as ms.net does.
CopyData = 'd',
CopyDone = 'c',
DataRow = 'D',
BackendKeyData = 'K',
CancelRequest = 'F',
CompletedResponse = 'C',
CopyDataRows = ' ',
CopyInResponse = 'G',
CopyOutResponse = 'H',
EmptyQueryResponse = 'I',
ErrorResponse = 'E',
FunctionCall = 'F',
FunctionCallResponse = 'V',
AuthenticationRequest = 'R',
NoticeResponse = 'N',
NotificationResponse = 'A',
ParameterStatus = 'S',
PasswordPacket = ' ',
ReadyForQuery = 'Z',
RowDescription = 'T',
SSLRequest = ' ',
// extended query backend messages
ParseComplete = '1',
BindComplete = '2',
PortalSuspended = 's',
ParameterDescription = 't',
NoData = 'n',
CloseComplete = '3'
}
enum StatementOrPortal : byte
{
Statement = (byte)'S',
Portal = (byte)'P'
}
}