Skip to content

Commit 7a03fe0

Browse files
committed
Remove overloaded 'us' in lightning-net-tokio
Variables named using the pronoun 'us' are confusing as they are overloaded for Connection and SocketDescriptor, often inconsistently. Use 'connection' and 'descriptor' instead.
1 parent 9f875f4 commit 7a03fe0

File tree

1 file changed

+44
-44
lines changed

1 file changed

+44
-44
lines changed

lightning-net-tokio/src/lib.rs

Lines changed: 44 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -44,13 +44,13 @@ pub struct Connection {
4444
}
4545
impl Connection {
4646
fn schedule_read<CMH: ChannelMessageHandler + 'static>(peer_manager: Arc<peer_handler::PeerManager<SocketDescriptor<CMH>, Arc<CMH>>>, us: Arc<Mutex<Self>>, reader: futures::stream::SplitStream<tokio_codec::Framed<TcpStream, tokio_codec::BytesCodec>>) {
47-
let us_ref = us.clone();
48-
let us_close_ref = us.clone();
49-
let peer_manager_ref = peer_manager.clone();
47+
let connection = us.clone();
48+
let connection_close = us.clone();
49+
let peer_manager_close = peer_manager.clone();
5050
tokio::spawn(reader.for_each(move |b| {
5151
let pending_read = b.to_vec();
5252
{
53-
let mut lock = us_ref.lock().unwrap();
53+
let mut lock = connection.lock().unwrap();
5454
assert!(lock.pending_read.is_empty());
5555
if lock.read_paused {
5656
lock.pending_read = pending_read;
@@ -60,31 +60,31 @@ impl Connection {
6060
}
6161
}
6262
//TODO: There's a race where we don't meet the requirements of disconnect_socket if its
63-
//called right here, after we release the us_ref lock in the scope above, but before we
63+
//called right here, after we release the connection lock in the scope above, but before we
6464
//call read_event!
65-
match peer_manager.read_event(&mut SocketDescriptor::new(us_ref.clone(), peer_manager.clone()), pending_read) {
65+
match peer_manager.read_event(&mut SocketDescriptor::new(connection.clone(), peer_manager.clone()), pending_read) {
6666
Ok(pause_read) => {
6767
if pause_read {
68-
let mut lock = us_ref.lock().unwrap();
68+
let mut lock = connection.lock().unwrap();
6969
lock.read_paused = true;
7070
}
7171
},
7272
Err(e) => {
73-
us_ref.lock().unwrap().need_disconnect = false;
73+
connection.lock().unwrap().need_disconnect = false;
7474
return future::Either::B(future::result(Err(std::io::Error::new(std::io::ErrorKind::InvalidData, e))));
7575
}
7676
}
7777

78-
if let Err(e) = us_ref.lock().unwrap().event_notify.try_send(()) {
78+
if let Err(e) = connection.lock().unwrap().event_notify.try_send(()) {
7979
// Ignore full errors as we just need them to poll after this point, so if the user
8080
// hasn't received the last send yet, it doesn't matter.
8181
assert!(e.is_full());
8282
}
8383

8484
future::Either::B(future::result(Ok(())))
8585
}).then(move |_| {
86-
if us_close_ref.lock().unwrap().need_disconnect {
87-
peer_manager_ref.disconnect_event(&SocketDescriptor::new(us_close_ref, peer_manager_ref.clone()));
86+
if connection_close.lock().unwrap().need_disconnect {
87+
peer_manager_close.disconnect_event(&SocketDescriptor::new(connection_close, peer_manager_close.clone()));
8888
println!("Peer disconnected!");
8989
} else {
9090
println!("We disconnected peer!");
@@ -101,9 +101,9 @@ impl Connection {
101101
})).then(|_| {
102102
future::result(Ok(()))
103103
}));
104-
let us = Arc::new(Mutex::new(Self { writer: Some(send_sink), event_notify, pending_read: Vec::new(), read_blocker: None, read_paused: false, need_disconnect: true, id: ID_COUNTER.fetch_add(1, Ordering::AcqRel) }));
104+
let connection = Arc::new(Mutex::new(Self { writer: Some(send_sink), event_notify, pending_read: Vec::new(), read_blocker: None, read_paused: false, need_disconnect: true, id: ID_COUNTER.fetch_add(1, Ordering::AcqRel) }));
105105

106-
(reader, us)
106+
(reader, connection)
107107
}
108108

109109
/// Process incoming messages and feed outgoing messages on the provided socket generated by
@@ -112,10 +112,10 @@ impl Connection {
112112
/// You should poll the Receive end of event_notify and call get_and_clear_pending_events() on
113113
/// ChannelManager and ChannelMonitor objects.
114114
pub fn setup_inbound<CMH: ChannelMessageHandler + 'static>(peer_manager: Arc<peer_handler::PeerManager<SocketDescriptor<CMH>, Arc<CMH>>>, event_notify: mpsc::Sender<()>, stream: TcpStream) {
115-
let (reader, us) = Self::new(event_notify, stream);
115+
let (reader, connection) = Self::new(event_notify, stream);
116116

117-
if let Ok(_) = peer_manager.new_inbound_connection(SocketDescriptor::new(us.clone(), peer_manager.clone())) {
118-
Self::schedule_read(peer_manager, us, reader);
117+
if let Ok(_) = peer_manager.new_inbound_connection(SocketDescriptor::new(connection.clone(), peer_manager.clone())) {
118+
Self::schedule_read(peer_manager, connection, reader);
119119
}
120120
}
121121

@@ -126,11 +126,11 @@ impl Connection {
126126
/// You should poll the Receive end of event_notify and call get_and_clear_pending_events() on
127127
/// ChannelManager and ChannelMonitor objects.
128128
pub fn setup_outbound<CMH: ChannelMessageHandler + 'static>(peer_manager: Arc<peer_handler::PeerManager<SocketDescriptor<CMH>, Arc<CMH>>>, event_notify: mpsc::Sender<()>, their_node_id: PublicKey, stream: TcpStream) {
129-
let (reader, us) = Self::new(event_notify, stream);
129+
let (reader, connection) = Self::new(event_notify, stream);
130130

131-
if let Ok(initial_send) = peer_manager.new_outbound_connection(their_node_id, SocketDescriptor::new(us.clone(), peer_manager.clone())) {
132-
if SocketDescriptor::new(us.clone(), peer_manager.clone()).send_data(&initial_send, true) == initial_send.len() {
133-
Self::schedule_read(peer_manager, us, reader);
131+
if let Ok(initial_send) = peer_manager.new_outbound_connection(their_node_id, SocketDescriptor::new(connection.clone(), peer_manager.clone())) {
132+
if SocketDescriptor::new(connection.clone(), peer_manager.clone()).send_data(&initial_send, true) == initial_send.len() {
133+
Self::schedule_read(peer_manager, connection, reader);
134134
} else {
135135
println!("Failed to write first full message to socket!");
136136
}
@@ -172,16 +172,16 @@ impl<CMH: ChannelMessageHandler> SocketDescriptor<CMH> {
172172
impl<CMH: ChannelMessageHandler> peer_handler::SocketDescriptor for SocketDescriptor<CMH> {
173173
fn send_data(&mut self, data: &[u8], resume_read: bool) -> usize {
174174
macro_rules! schedule_read {
175-
($us_ref: expr) => {
175+
($descriptor: expr) => {
176176
tokio::spawn(future::lazy(move || -> Result<(), ()> {
177177
let mut read_data = Vec::new();
178178
{
179-
let mut us = $us_ref.conn.lock().unwrap();
180-
mem::swap(&mut read_data, &mut us.pending_read);
179+
let mut connection = $descriptor.conn.lock().unwrap();
180+
mem::swap(&mut read_data, &mut connection.pending_read);
181181
}
182182
if !read_data.is_empty() {
183-
let mut us_clone = $us_ref.clone();
184-
match $us_ref.peer_manager.read_event(&mut us_clone, read_data) {
183+
//let mut us_clone = $descriptor.clone();
184+
match $descriptor.peer_manager.read_event(&mut $descriptor.clone(), read_data) {
185185
Ok(pause_read) => {
186186
if pause_read { return Ok(()); }
187187
},
@@ -191,12 +191,12 @@ impl<CMH: ChannelMessageHandler> peer_handler::SocketDescriptor for SocketDescri
191191
}
192192
}
193193
}
194-
let mut us = $us_ref.conn.lock().unwrap();
195-
if let Some(sender) = us.read_blocker.take() {
194+
let mut connection = $descriptor.conn.lock().unwrap();
195+
if let Some(sender) = connection.read_blocker.take() {
196196
sender.send(Ok(())).unwrap();
197197
}
198-
us.read_paused = false;
199-
if let Err(e) = us.event_notify.try_send(()) {
198+
connection.read_paused = false;
199+
if let Err(e) = connection.event_notify.try_send(()) {
200200
// Ignore full errors as we just need them to poll after this point, so if the user
201201
// hasn't received the last send yet, it doesn't matter.
202202
assert!(e.is_full());
@@ -206,36 +206,36 @@ impl<CMH: ChannelMessageHandler> peer_handler::SocketDescriptor for SocketDescri
206206
}
207207
}
208208

209-
let mut us = self.conn.lock().unwrap();
209+
let mut connection = self.conn.lock().unwrap();
210210
if resume_read {
211-
let us_ref = self.clone();
212-
schedule_read!(us_ref);
211+
let descriptor = self.clone();
212+
schedule_read!(descriptor);
213213
}
214214
if data.is_empty() { return 0; }
215-
if us.writer.is_none() {
216-
us.read_paused = true;
215+
if connection.writer.is_none() {
216+
connection.read_paused = true;
217217
return 0;
218218
}
219219

220220
let mut bytes = bytes::BytesMut::with_capacity(data.len());
221221
bytes.put(data);
222-
let write_res = us.writer.as_mut().unwrap().start_send(bytes.freeze());
222+
let write_res = connection.writer.as_mut().unwrap().start_send(bytes.freeze());
223223
match write_res {
224224
Ok(res) => {
225225
match res {
226226
AsyncSink::Ready => {
227227
data.len()
228228
},
229229
AsyncSink::NotReady(_) => {
230-
us.read_paused = true;
231-
let us_ref = self.clone();
232-
tokio::spawn(us.writer.take().unwrap().flush().then(move |writer_res| -> Result<(), ()> {
230+
connection.read_paused = true;
231+
let descriptor = self.clone();
232+
tokio::spawn(connection.writer.take().unwrap().flush().then(move |writer_res| -> Result<(), ()> {
233233
if let Ok(writer) = writer_res {
234234
{
235-
let mut us = us_ref.conn.lock().unwrap();
236-
us.writer = Some(writer);
235+
let mut connection = descriptor.conn.lock().unwrap();
236+
connection.writer = Some(writer);
237237
}
238-
schedule_read!(us_ref);
238+
schedule_read!(descriptor);
239239
} // we'll fire the disconnect event on the socket reader end
240240
Ok(())
241241
}));
@@ -251,9 +251,9 @@ impl<CMH: ChannelMessageHandler> peer_handler::SocketDescriptor for SocketDescri
251251
}
252252

253253
fn disconnect_socket(&mut self) {
254-
let mut us = self.conn.lock().unwrap();
255-
us.need_disconnect = true;
256-
us.read_paused = true;
254+
let mut connection = self.conn.lock().unwrap();
255+
connection.need_disconnect = true;
256+
connection.read_paused = true;
257257
}
258258
}
259259
impl<CMH: ChannelMessageHandler> Clone for SocketDescriptor<CMH> {

0 commit comments

Comments
 (0)