[
https://issues.apache.org/jira/browse/SSHD-1080?focusedWorklogId=485745&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-485745
]
ASF GitHub Bot logged work on SSHD-1080:
----------------------------------------
Author: ASF GitHub Bot
Created on: 17/Sep/20 13:43
Start Date: 17/Sep/20 13:43
Worklog Time Spent: 10m
Work Description: gnodet commented on a change in pull request #169:
URL: https://github.com/apache/mina-sshd/pull/169#discussion_r490256539
##########
File path:
sshd-core/src/main/java/org/apache/sshd/common/channel/throttle/DefaultChannelStreamWriter.java
##########
@@ -0,0 +1,53 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+package org.apache.sshd.common.channel.throttle;
+
+import java.io.IOException;
+
+import org.apache.sshd.common.channel.Channel;
+import org.apache.sshd.common.io.IoWriteFuture;
+import org.apache.sshd.common.util.buffer.Buffer;
+
+public class DefaultChannelStreamWriter implements ChannelStreamWriter {
Review comment:
The javadoc is a bit more specific to the session, so I think it's worth
overriding the method.
##########
File path: sshd-common/src/main/java/org/apache/sshd/common/io/IoSession.java
##########
@@ -82,6 +84,27 @@
*/
Object removeAttribute(Object key);
+ /**
+ * Write a packet on the socket. Multiple writes can be issued
concurrently and will be queued.
+ *
+ * @param buffer the buffer send. <B>NOTE:</B> the buffer must not
be touched until the returned write future
+ * is completed.
+ * @return An {@code IoWriteFuture} that can be used to check
when the packet has actually been sent
+ * @throws IOException if an error occurred when sending the packet
+ */
+ IoWriteFuture writePacket(Buffer buffer) throws IOException;
+
+ /**
+ * Closes this session immediately or after all queued write requests are
flushed. This operation is asynchronous.
+ * Wait for the returned {@link CloseFuture} if you want to wait for the
session actually closed.
+ *
+ * @param immediately {@code true} to close this session immediately. The
pending write requests will simply be
+ * discarded. {@code false} to close this session
after all queued write requests are flushed.
+ * @return The generated {@link CloseFuture}
+ */
+ @Override
+ CloseFuture close(boolean immediately);
+
Review comment:
The javadoc is a bit more specific to the session, so I think it's worth
overriding the method.
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
Issue Time Tracking
-------------------
Worklog Id: (was: 485745)
Time Spent: 0.5h (was: 20m)
> Revisit the PacketWriter interface
> ----------------------------------
>
> Key: SSHD-1080
> URL: https://issues.apache.org/jira/browse/SSHD-1080
> Project: MINA SSHD
> Issue Type: Improvement
> Reporter: Guillaume Nodet
> Priority: Major
> Time Spent: 0.5h
> Remaining Estimate: 0h
>
> The expectations when using {{Session.writePacket}}, {{Channel.writePacket}}
> and {{IoOutputStream.writePacket}} are different, so I don't think it's a
> good idea to use a single interface for those.
> The only real place where it's used is in the {{ThrottlingPacketWriter}}
> which would need to be reworked.
--
This message was sent by Atlassian Jira
(v8.3.4#803005)
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
