Github user rxin commented on a diff in the pull request:
https://github.com/apache/spark/pull/2240#discussion_r17031070
--- Diff: core/src/main/scala/org/apache/spark/network/ManagedBuffer.scala
---
@@ -0,0 +1,101 @@
+/*
+ * 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.spark.network
+
+import java.io.{RandomAccessFile, File, FileInputStream, InputStream}
+import java.nio.ByteBuffer
+import java.nio.channels.FileChannel.MapMode
+
+import io.netty.buffer.{ByteBufInputStream, ByteBuf, Unpooled}
+import io.netty.channel.DefaultFileRegion
+
+import org.apache.spark.storage.FileSegment
+import org.apache.spark.util.ByteBufferInputStream
+
+
+/**
+ * Provides a buffer abstraction that allows pooling and reuse.
+ */
+abstract class ManagedBuffer {
+ // Note that all the methods are defined with parenthesis because their
implementations can
+ // have side effects (io operations).
+
+ def byteBuffer(): ByteBuffer
+
+ def fileSegment(): Option[FileSegment] = None
+
+ def inputStream(): InputStream = throw new UnsupportedOperationException
+
+ def release(): Unit = throw new UnsupportedOperationException
+
+ def size: Long
+
+ private[network] def toNetty(): AnyRef
--- End diff --
toNetty actually applies to all managed buffers. We can move this into the
netty package, but in that case we lose the compile time check because somebody
could add a new implementation of the ManagedBuffer and forget to update the
netty part of the code.
That said, I will add some inline doc to explain the purpose of this.
---
If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at infrastruct...@apache.org or file a JIRA ticket
with INFRA.
---
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscr...@spark.apache.org
For additional commands, e-mail: reviews-h...@spark.apache.org
