Skip to content

Commit f061718

Browse files
michaelklishinmichaelklishin
committed
Rename ReadFrame and WriteFrame
There are no "read frames" and "write frames" in the protocol. "Incoming" and "outgoing" frames are also not well established terms but at least they hint at what the difference is and when they are used. There are existing methods with identical names (ReadFrame, WriteFrame) as well, which isn't helping.
1 parent 260444e commit f061718

File tree

11 files changed

+37
-39
lines changed

11 files changed

+37
-39
lines changed

‎projects/client/RabbitMQ.Client/src/client/impl/Command.cs

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -99,7 +99,7 @@ public byte[] Body
9999

100100
public static void CheckEmptyFrameSize()
101101
{
102-
var f = new EmptyWriteFrame();
102+
var f = new EmptyOutboundFrame();
103103
var stream = new MemoryStream();
104104
var writer = new NetworkBinaryWriter(stream);
105105
f.WriteTo(writer);
@@ -142,25 +142,25 @@ public void Transmit(int channelNumber, Connection connection)
142142

143143
public void TransmitAsSingleFrame(int channelNumber, Connection connection)
144144
{
145-
connection.WriteFrame(new MethodWriteFrame(channelNumber, Method));
145+
connection.WriteFrame(new MethodOutboundFrame(channelNumber, Method));
146146
}
147147

148148
public void TransmitAsFrameSet(int channelNumber, Connection connection)
149149
{
150-
var frames = new List<WriteFrame>();
151-
frames.Add(new MethodWriteFrame(channelNumber, Method));
150+
var frames = new List<OutboundFrame>();
151+
frames.Add(new MethodOutboundFrame(channelNumber, Method));
152152
if (Method.HasContent)
153153
{
154154
var body = ConsolidateBody(); // Cache, since the property is compiled.
155155

156-
frames.Add(new HeaderWriteFrame(channelNumber, Header, body.Length));
156+
frames.Add(new HeaderOutboundFrame(channelNumber, Header, body.Length));
157157
var frameMax = (int)Math.Min(int.MaxValue, connection.FrameMax);
158158
var bodyPayloadMax = (frameMax == 0) ? body.Length : frameMax - EmptyFrameSize;
159159
for (int offset = 0; offset < body.Length; offset += bodyPayloadMax)
160160
{
161161
var remaining = body.Length - offset;
162162
var count = (remaining < bodyPayloadMax) ? remaining : bodyPayloadMax;
163-
frames.Add(new BodySegmentWriteFrame(channelNumber, body, offset, count));
163+
frames.Add(new BodySegmentOutboundFrame(channelNumber, body, offset, count));
164164
}
165165
}
166166

‎projects/client/RabbitMQ.Client/src/client/impl/CommandAssembler.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ public CommandAssembler(ProtocolBase protocol)
6868
Reset();
6969
}
7070

71-
public Command HandleFrame(ReadFrame f)
71+
public Command HandleFrame(InboundFrame f)
7272
{
7373
switch (m_state)
7474
{

‎projects/client/RabbitMQ.Client/src/client/impl/Connection.cs

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ public class Connection : IConnection
6767
private readonly object m_eventLock = new object();
6868

6969
///<summary>Heartbeat frame for transmission. Reusable across connections.</summary>
70-
private readonly EmptyWriteFrame m_heartbeatFrame = new EmptyWriteFrame();
70+
private readonly EmptyOutboundFrame m_heartbeatFrame = new EmptyOutboundFrame();
7171

7272
private ManualResetEvent m_appContinuation = new ManualResetEvent(false);
7373
private EventHandler<CallbackExceptionEventArgs> m_callbackException;
@@ -716,7 +716,7 @@ public void MainLoop()
716716

717717
public void MainLoopIteration()
718718
{
719-
ReadFrame frame = m_frameHandler.ReadFrame();
719+
InboundFrame frame = m_frameHandler.ReadFrame();
720720

721721
NotifyHeartbeatListener();
722722
// We have received an actual frame.
@@ -1168,13 +1168,13 @@ public override string ToString()
11681168
return string.Format("Connection({0},{1})", m_id, Endpoint);
11691169
}
11701170

1171-
public void WriteFrame(WriteFrame f)
1171+
public void WriteFrame(OutboundFrame f)
11721172
{
11731173
m_frameHandler.WriteFrame(f);
11741174
m_heartbeatWrite.Set();
11751175
}
11761176

1177-
public void WriteFrameSet(IList<WriteFrame> f)
1177+
public void WriteFrameSet(IList<OutboundFrame> f)
11781178
{
11791179
m_frameHandler.WriteFrameSet(f);
11801180
m_heartbeatWrite.Set();

‎projects/client/RabbitMQ.Client/src/client/impl/Frame.cs

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -54,9 +54,9 @@
5454

5555
namespace RabbitMQ.Client.Impl
5656
{
57-
public class HeaderWriteFrame : WriteFrame
57+
public class HeaderOutboundFrame : OutboundFrame
5858
{
59-
public HeaderWriteFrame(int channel, ContentHeaderBase header, int bodyLength) : base(FrameType.FrameHeader, channel)
59+
public HeaderOutboundFrame(int channel, ContentHeaderBase header, int bodyLength) : base(FrameType.FrameHeader, channel)
6060
{
6161
NetworkBinaryWriter writer = base.GetWriter();
6262

@@ -65,19 +65,19 @@ public HeaderWriteFrame(int channel, ContentHeaderBase header, int bodyLength) :
6565
}
6666
}
6767

68-
public class BodySegmentWriteFrame : WriteFrame
68+
public class BodySegmentOutboundFrame : OutboundFrame
6969
{
70-
public BodySegmentWriteFrame(int channel, byte[] body, int offset, int count) : base(FrameType.FrameBody, channel)
70+
public BodySegmentOutboundFrame(int channel, byte[] body, int offset, int count) : base(FrameType.FrameBody, channel)
7171
{
7272
NetworkBinaryWriter writer = base.GetWriter();
7373

7474
writer.Write(body, offset, count);
7575
}
7676
}
7777

78-
public class MethodWriteFrame : WriteFrame
78+
public class MethodOutboundFrame : OutboundFrame
7979
{
80-
public MethodWriteFrame(int channel, MethodBase method) : base(FrameType.FrameMethod, channel)
80+
public MethodOutboundFrame(int channel, MethodBase method) : base(FrameType.FrameMethod, channel)
8181
{
8282
NetworkBinaryWriter writer = base.GetWriter();
8383

@@ -92,11 +92,11 @@ public MethodWriteFrame(int channel, MethodBase method) : base(FrameType.FrameMe
9292
}
9393
}
9494

95-
public class EmptyWriteFrame : WriteFrame
95+
public class EmptyOutboundFrame : OutboundFrame
9696
{
9797
private static readonly byte[] m_emptyByteArray = new byte[0];
9898

99-
public EmptyWriteFrame() : base(FrameType.FrameHeartbeat, 0)
99+
public EmptyOutboundFrame() : base(FrameType.FrameHeartbeat, 0)
100100
{
101101
base.GetWriter().Write(m_emptyByteArray);
102102
}
@@ -112,12 +112,12 @@ public override string ToString()
112112
}
113113
}
114114

115-
public class WriteFrame : Frame
115+
public class OutboundFrame : Frame
116116
{
117117
private readonly MemoryStream m_accumulator;
118118
private readonly NetworkBinaryWriter writer;
119119

120-
public WriteFrame(FrameType type, int channel) : base(type, channel)
120+
public OutboundFrame(FrameType type, int channel) : base(type, channel)
121121
{
122122
m_accumulator = new MemoryStream();
123123
writer = new NetworkBinaryWriter(m_accumulator);
@@ -150,9 +150,9 @@ public void WriteTo(NetworkBinaryWriter writer)
150150
}
151151
}
152152

153-
public class ReadFrame : Frame
153+
public class InboundFrame : Frame
154154
{
155-
private ReadFrame(FrameType type, int channel, byte[] payload) : base(type, channel, payload)
155+
private InboundFrame(FrameType type, int channel, byte[] payload) : base(type, channel, payload)
156156
{
157157
}
158158

@@ -190,7 +190,7 @@ private static void ProcessProtocolHeader(NetworkBinaryReader reader)
190190
}
191191
}
192192

193-
public static ReadFrame ReadFrom(NetworkBinaryReader reader)
193+
public static InboundFrame ReadFrom(NetworkBinaryReader reader)
194194
{
195195
int type;
196196

@@ -245,7 +245,7 @@ public static ReadFrame ReadFrom(NetworkBinaryReader reader)
245245
throw new MalformedFrameException("Bad frame end marker: " + frameEndMarker);
246246
}
247247

248-
return new ReadFrame((FrameType)type, channel, payload);
248+
return new InboundFrame((FrameType)type, channel, payload);
249249
}
250250

251251
public NetworkBinaryReader GetReader()

‎projects/client/RabbitMQ.Client/src/client/impl/IFrameHandler.cs

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -71,14 +71,12 @@ public interface IFrameHandler
7171
///<summary>Read a frame from the underlying
7272
///transport. Returns null if the read operation timed out
7373
///(see Timeout property).</summary>
74-
ReadFrame ReadFrame();
74+
InboundFrame ReadFrame();
7575

7676
void SendHeader();
7777

78-
void WriteFrame(WriteFrame frame);
78+
void WriteFrame(OutboundFrame frame);
7979

80-
void WriteFrameSet(IList<WriteFrame> frames);
81-
82-
//void Flush();
80+
void WriteFrameSet(IList<OutboundFrame> frames);
8381
}
8482
}

‎projects/client/RabbitMQ.Client/src/client/impl/ISession.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ public interface ISession
7676

7777
void Close(ShutdownEventArgs reason);
7878
void Close(ShutdownEventArgs reason, bool notify);
79-
void HandleFrame(ReadFrame frame);
79+
void HandleFrame(InboundFrame frame);
8080
void Notify();
8181
void Transmit(Command cmd);
8282
}

‎projects/client/RabbitMQ.Client/src/client/impl/MainSession.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ public MainSession(Connection connection) : base(connection, 0)
7272

7373
public Action Handler { get; set; }
7474

75-
public override void HandleFrame(ReadFrame frame)
75+
public override void HandleFrame(InboundFrame frame)
7676
{
7777
lock (_closingLock)
7878
{

‎projects/client/RabbitMQ.Client/src/client/impl/QuiescingSession.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ public QuiescingSession(Connection connection,
6060
m_reason = reason;
6161
}
6262

63-
public override void HandleFrame(ReadFrame frame)
63+
public override void HandleFrame(InboundFrame frame)
6464
{
6565
if (frame.IsMethod())
6666
{

‎projects/client/RabbitMQ.Client/src/client/impl/Session.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ public Session(Connection connection, int channelNumber)
5454
m_assembler = new CommandAssembler(connection.Protocol);
5555
}
5656

57-
public override void HandleFrame(ReadFrame frame)
57+
public override void HandleFrame(InboundFrame frame)
5858
{
5959
Command cmd = m_assembler.HandleFrame(frame);
6060
if (cmd != null)

‎projects/client/RabbitMQ.Client/src/client/impl/SessionBase.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ public void Close(ShutdownEventArgs reason, bool notify)
161161
}
162162
}
163163

164-
public abstract void HandleFrame(ReadFrame frame);
164+
public abstract void HandleFrame(InboundFrame frame);
165165

166166
public void Notify()
167167
{

0 commit comments

Comments
 (0)