aboutsummaryrefslogtreecommitdiff
path: root/okio/src/commonMain/kotlin/okio/SegmentPool.kt
diff options
context:
space:
mode:
Diffstat (limited to 'okio/src/commonMain/kotlin/okio/SegmentPool.kt')
-rw-r--r--okio/src/commonMain/kotlin/okio/SegmentPool.kt36
1 files changed, 36 insertions, 0 deletions
diff --git a/okio/src/commonMain/kotlin/okio/SegmentPool.kt b/okio/src/commonMain/kotlin/okio/SegmentPool.kt
new file mode 100644
index 00000000..f21c7a29
--- /dev/null
+++ b/okio/src/commonMain/kotlin/okio/SegmentPool.kt
@@ -0,0 +1,36 @@
+/*
+ * Copyright (C) 2014 Square, Inc.
+ *
+ * Licensed 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 okio
+
+/**
+ * A collection of unused segments, necessary to avoid GC churn and zero-fill.
+ * This pool is a thread-safe static singleton.
+ */
+internal expect object SegmentPool {
+ val MAX_SIZE: Int
+
+ /**
+ * For testing only. Returns a snapshot of the number of bytes currently in the pool. If the pool
+ * is segmented such as by thread, this returns the byte count accessible to the calling thread.
+ */
+ val byteCount: Int
+
+ /** Return a segment for the caller's use. */
+ fun take(): Segment
+
+ /** Recycle a segment that the caller no longer needs. */
+ fun recycle(segment: Segment)
+}