Logger and annotations

src/main/java/in/dragonbra/javasteam/networking/steam3/WebSocketConnection.kt

@@ -34,7 +34,7 @@ class WebSocketConnection :
     CoroutineScope {
 
     companion object {
-        private val logger = LogManager.getLogger(WebSocketConnection::class.java)
+        private val logger = LogManager.getLogger<WebSocketConnection>()
     }
 
     private val job: Job = SupervisorJob()

src/main/java/in/dragonbra/javasteam/steam/authentication/AuthSession.kt

@@ -39,7 +39,7 @@ open class AuthSession(
 ) {
 
     companion object {
-        private val logger = LogManager.getLogger(AuthSession::class.java)
+        private val logger = LogManager.getLogger<AuthSession>()
     }
 
     init {

src/main/java/in/dragonbra/javasteam/steam/cdn/Client.kt

@@ -38,7 +38,7 @@ class Client(steamClient: SteamClient) : Closeable {
 
     companion object {
 
-        private val logger: Logger = LogManager.getLogger(Client::class.java)
+        private val logger: Logger = LogManager.getLogger<Client>()
 
         /**
          * Default timeout to use when making requests

src/main/java/in/dragonbra/javasteam/steam/cdn/ClientPool.kt

@@ -39,7 +39,7 @@ class ClientPool(internal val steamClient: SteamClient, private val appId: Int,
 
     private val monitorJob: Job
 
-    private val logger: Logger = LogManager.getLogger(ClientPool::class.java)
+    private val logger: Logger = LogManager.getLogger<ClientPool>()
 
     init {
         monitorJob = parentScope.launch { connectionPoolMonitor().await() }

src/main/java/in/dragonbra/javasteam/steam/discovery/FileServerListProvider.kt

@@ -20,6 +20,10 @@ import java.time.Instant
  */
 class FileServerListProvider(val file: Path) : IServerListProvider {
 
+    companion object {
+        private val logger: Logger = LogManager.getLogger<FileServerListProvider>()
+    }
+
     /**
      * Instantiates a [FileServerListProvider] object.
      * @param file the file that will store the servers
@@ -102,8 +106,4 @@ class FileServerListProvider(val file: Path) : IServerListProvider {
             logger.error("Failed to write servers to file ${file.fileName}", e)
         }
     }
-
-    companion object {
-        private val logger: Logger = LogManager.getLogger(FileServerListProvider::class.java)
-    }
 }

src/main/java/in/dragonbra/javasteam/steam/discovery/ServerRecord.kt

@@ -54,7 +54,8 @@ class ServerRecord private constructor(
     override fun hashCode(): Int = endpoint.hashCode() xor protocolTypes.hashCode()
 
     companion object {
-        private val logger = LogManager.getLogger(ServerRecord::class.java)
+
+        private val logger = LogManager.getLogger<ServerRecord>()
 
         /**
          * Creates a server record for a given endpoint.

src/main/java/in/dragonbra/javasteam/steam/discovery/SmartCMServerList.kt

@@ -18,7 +18,8 @@ import java.util.EnumSet
 class SmartCMServerList(private val configuration: SteamConfiguration) {
 
     companion object {
-        private val logger: Logger = LogManager.getLogger(SmartCMServerList::class.java)
+
+        private val logger: Logger = LogManager.getLogger<SmartCMServerList>()
 
         /**
          * The default fallback Websockets server to attempt connecting to if fetching server list through other means fails.

src/main/java/in/dragonbra/javasteam/steam/handlers/steamapps/PICSProductInfo.kt

@@ -19,7 +19,7 @@ import java.util.*
 class PICSProductInfo : CallbackMsg {
 
     companion object {
-        private val logger = LogManager.getLogger(PICSProductInfo::class.java)
+        private val logger = LogManager.getLogger<PICSProductInfo>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamapps/SteamApps.kt

@@ -38,6 +38,7 @@ import `in`.dragonbra.javasteam.steam.steamclient.callbackmgr.CallbackMsg
 import `in`.dragonbra.javasteam.types.AsyncJobMultiple
 import `in`.dragonbra.javasteam.types.AsyncJobSingle
 import `in`.dragonbra.javasteam.types.GameID
+import `in`.dragonbra.javasteam.util.JavaSteamAddition
 import `in`.dragonbra.javasteam.util.NetHelpers
 import io.ktor.client.request.request
 
@@ -345,7 +346,7 @@ class SteamApps : ClientMsgHandler() {
      * @param gameId Holds information pertaining to the app being launched
      * @param usageEvent The type of launch occurring
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     fun sendClientAppUsageEvent(
         gameId: GameID,
         usageEvent: EAppUsageEvent,
@@ -365,7 +366,7 @@ class SteamApps : ClientMsgHandler() {
      * @param gamesPlayed The list of the different game processes
      * @param clientOsType The OS type of the client launching the games
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @Suppress("DuplicatedCode", "unused")
     @JvmOverloads
     fun notifyGamesPlayed(

src/main/java/in/dragonbra/javasteam/steam/handlers/steamapps/callback/GuestPassListCallback.kt

@@ -15,7 +15,7 @@ import java.io.IOException
 class GuestPassListCallback(packetMsg: IPacketMsg) : CallbackMsg() {
 
     companion object {
-        private val logger = LogManager.getLogger(GuestPassListCallback::class.java)
+        private val logger = LogManager.getLogger<GuestPassListCallback>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamapps/callback/PurchaseResponseCallback.kt

@@ -17,7 +17,7 @@ import `in`.dragonbra.javasteam.util.stream.MemoryStream
 class PurchaseResponseCallback(packetMsg: IPacketMsg) : CallbackMsg() {
 
     companion object {
-        private val logger = LogManager.getLogger(PurchaseResponseCallback::class.java)
+        private val logger = LogManager.getLogger<PurchaseResponseCallback>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamapps/callback/VACStatusCallback.kt

@@ -15,7 +15,7 @@ import java.util.*
 class VACStatusCallback(packetMsg: IPacketMsg) : CallbackMsg() {
 
     companion object {
-        private val logger = LogManager.getLogger(VACStatusCallback::class.java)
+        private val logger = LogManager.getLogger<VACStatusCallback>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamcloud/SteamCloud.kt

@@ -34,6 +34,7 @@ import `in`.dragonbra.javasteam.steam.steamclient.callbackmgr.CallbackMsg
 import `in`.dragonbra.javasteam.types.AsyncJobSingle
 import `in`.dragonbra.javasteam.types.UGCHandle
 import `in`.dragonbra.javasteam.util.HardwareUtils
+import `in`.dragonbra.javasteam.util.JavaSteamAddition
 import kotlinx.coroutines.CoroutineScope
 import kotlinx.coroutines.Dispatchers
 import kotlinx.coroutines.future.future
@@ -135,7 +136,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param syncedChangeNumber The sync change number
      * @return A [AppFileChangeList] containing the files changed
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun getAppFileListChange(
         appId: Int,
@@ -161,7 +162,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param forceProxy Whether to force proxy
      * @return A [FileDownloadInfo] containing information about how to download the user file
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun clientFileDownload(
         appId: Int,
@@ -193,7 +194,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param appBuildId    The build ID of the app
      * @return An [AppUploadBatchResponse] containing the batch ID and the app change number
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun beginAppUploadBatch(
         appId: Int,
@@ -229,7 +230,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param uploadBatchId The ID of the upload batch this file upload belongs to (see [beginAppUploadBatch])
      * @return The upload information needed to upload the file in blocks
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     fun beginFileUpload(
         appId: Int,
         fileSize: Int,
@@ -274,7 +275,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param filename          The path of the file including the prefix (ex %GameInstall%)
      * @return Whether the file has been committed
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun commitFileUpload(
         transferSucceeded: Boolean,
@@ -302,7 +303,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param batchId      The ID of the batch
      * @param batchEResult The result of the upload batch
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun completeAppUploadBatch(
         appId: Int,
@@ -334,7 +335,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param microsecDownloadFiles The time the sync took to download all the required files in micro-seconds
      * @param microsecUploadFiles The time the sync took to upload all the required files in micro-seconds
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun appCloudSyncStats(
         appId: Int,
@@ -418,7 +419,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param osType                  The OS type of the machine launching the app
      * @return A list of the pending remote operations, empty if none
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun signalAppLaunchIntent(
         appId: Int,
@@ -450,7 +451,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param appId    The ID of the app who finished syncing
      * @param clientId The ID given when authenticating the user [AuthSession.clientID]
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     fun signalAppExitSyncDone(
         appId: Int,
         clientId: Long,
@@ -481,7 +482,7 @@ class SteamCloud : ClientMsgHandler() {
      * @param cellId         The cell ID
      * @param proxied        Whether the transfer was through a proxy
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     @JvmOverloads
     fun externalStorageTransferReport(
         host: String,

src/main/java/in/dragonbra/javasteam/steam/handlers/steamfriends/SteamFriends.kt

@@ -65,6 +65,7 @@ import `in`.dragonbra.javasteam.types.AsyncJobSingle
 import `in`.dragonbra.javasteam.types.GameID
 import `in`.dragonbra.javasteam.types.JobID
 import `in`.dragonbra.javasteam.types.SteamID
+import `in`.dragonbra.javasteam.util.JavaSteamAddition
 import `in`.dragonbra.javasteam.util.log.LogManager
 import `in`.dragonbra.javasteam.util.log.Logger
 import java.io.IOException
@@ -79,6 +80,7 @@ class SteamFriends : ClientMsgHandler() {
 
     var friendsList: MutableList<SteamID> = mutableListOf()
         private set
+
     var clanList: MutableList<SteamID> = mutableListOf()
         private set
 
@@ -182,9 +184,9 @@ class SteamFriends : ClientMsgHandler() {
     }
 
     /**
-     * JavaSteam addition:
      * Sets the local user's persona state flag back to normal desktop mode.
      */
+    @JavaSteamAddition
     fun resetPersonaStateFlag() {
         ClientMsgProtobuf<CMsgClientChangeStatus.Builder>(
             CMsgClientChangeStatus::class.java,
@@ -196,15 +198,14 @@ class SteamFriends : ClientMsgHandler() {
     }
 
     /**
-     * JavaSteam addition:
      * Sets the local user's persona state flag to a valid ClientType
-     *
      * @param flag one of the following
      * [EPersonaStateFlag.ClientTypeWeb],
      * [EPersonaStateFlag.ClientTypeMobile],
      * [EPersonaStateFlag.ClientTypeTenfoot],
      * or [EPersonaStateFlag.ClientTypeVR].
      */
+    @JavaSteamAddition
     fun setPersonaStateFlag(flag: EPersonaStateFlag) {
         require(!(flag.code() < EPersonaStateFlag.ClientTypeWeb.code() || flag.code() > EPersonaStateFlag.ClientTypeVR.code())) { "Persona State Flag was not a valid ClientType" }
 
@@ -897,7 +898,8 @@ class SteamFriends : ClientMsgHandler() {
     }
 
     companion object {
-        private val logger: Logger = LogManager.getLogger(SteamFriends::class.java)
+
+        private val logger: Logger = LogManager.getLogger<SteamFriends>()
 
         private fun getCallback(packetMsg: IPacketMsg): CallbackMsg? = when (packetMsg.msgType) {
             EMsg.ClientClanState -> ClanStateCallback(packetMsg)

src/main/java/in/dragonbra/javasteam/steam/handlers/steamfriends/callback/ChatEnterCallback.kt

@@ -18,7 +18,7 @@ import `in`.dragonbra.javasteam.util.stream.BinaryReader
 class ChatEnterCallback(packetMsg: IPacketMsg) : CallbackMsg() {
 
     companion object {
-        private val logger = LogManager.getLogger(ChatEnterCallback::class.java)
+        private val logger = LogManager.getLogger<ChatEnterCallback>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamfriends/callback/ChatMemberInfoCallback.kt

@@ -21,7 +21,7 @@ import java.util.*
 class ChatMemberInfoCallback(packetMsg: IPacketMsg) : CallbackMsg() {
 
     companion object {
-        private val logger = LogManager.getLogger(ChatMemberInfoCallback::class.java)
+        private val logger = LogManager.getLogger<ChatMemberInfoCallback>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamuser/SteamUser.kt

@@ -28,6 +28,7 @@ import `in`.dragonbra.javasteam.steam.steamclient.callbackmgr.CallbackMsg
 import `in`.dragonbra.javasteam.steam.steamclient.callbacks.DisconnectedCallback
 import `in`.dragonbra.javasteam.types.SteamID
 import `in`.dragonbra.javasteam.util.HardwareUtils
+import `in`.dragonbra.javasteam.util.JavaSteamAddition
 import `in`.dragonbra.javasteam.util.NetHelpers
 
 /**
@@ -191,7 +192,7 @@ class SteamUser : ClientMsgHandler() {
      *
      * @param onlyStopGame Whether to only stop the game or quit the Steam client as well
      */
-    // JavaSteam Addition
+    @JavaSteamAddition
     fun kickPlayingSession(
         onlyStopGame: Boolean = false,
     ) {

src/main/java/in/dragonbra/javasteam/steam/handlers/steamuser/callback/LoggedOnCallback.kt

@@ -25,7 +25,7 @@ import java.util.*
 class LoggedOnCallback : CallbackMsg {
 
     companion object {
-        private val logger = LogManager.getLogger(LoggedOnCallback::class.java)
+        private val logger = LogManager.getLogger<LoggedOnCallback>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamuser/callback/MarketingMessageCallback.kt

@@ -18,6 +18,10 @@ import java.util.*
  */
 class MarketingMessageCallback(packetMsg: IPacketMsg) : CallbackMsg() {
 
+    companion object {
+        private val logger: Logger = LogManager.getLogger<MarketingMessageCallback>()
+    }
+
     /**
      * Gets the time of this marketing message update.
      */
@@ -88,8 +92,4 @@ class MarketingMessageCallback(packetMsg: IPacketMsg) : CallbackMsg() {
             }
         }
     }
-
-    companion object {
-        private val logger: Logger = LogManager.getLogger(MarketingMessageCallback::class.java)
-    }
 }

src/main/java/in/dragonbra/javasteam/steam/handlers/steamuserstats/AchievementBlocks.kt

@@ -1,10 +1,12 @@
 package `in`.dragonbra.javasteam.steam.handlers.steamuserstats
 
-// JavaSteam Addition
+import `in`.dragonbra.javasteam.util.JavaSteamAddition
+
 /**
  * A Block of achievements with the timestamp of when the achievement (in order of the schema) is unlocked.
  * @param achievementId the achievement id.
  * @param unlockTime a [List] of integers containing when an achievement was unlocked.
  *  An unlockTime of 0 means it has not been achieved, unlocked achievements are displayed as valve-timestamps.
  */
+@JavaSteamAddition
 data class AchievementBlocks(val achievementId: Int, val unlockTime: List<Int>)

src/main/java/in/dragonbra/javasteam/steam/handlers/steamuserstats/LeaderboardEntry.kt

@@ -15,7 +15,7 @@ import java.io.IOException
 class LeaderboardEntry(entry: CMsgClientLBSGetLBEntriesResponse.Entry) {
 
     companion object {
-        private val logger = LogManager.getLogger(LeaderboardEntry::class.java)
+        private val logger = LogManager.getLogger<LeaderboardEntry>()
     }
 
     /**

src/main/java/in/dragonbra/javasteam/steam/handlers/steamuserstats/Stats.kt

@@ -1,10 +1,12 @@
 package `in`.dragonbra.javasteam.steam.handlers.steamuserstats
 
-// JavaSteam Addition
+import `in`.dragonbra.javasteam.util.JavaSteamAddition
+
 /**
  * A Class representing stat values of a game.
  *  This data is commonly used for richer stats in games that support it. For example: Left 4 Dead 2.
  * @param statId The id of the stat. This is used to reference the id in the schema.
  * @param statValue The value of the stat.
  */
+@JavaSteamAddition
 data class Stats(val statId: Int, val statValue: Int)