Skip to content

Protocol: introduce DBusAddress as a rename of Address. #372

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
tmds merged 1 commit into from
Jan 14, 2026
Merged

Protocol: introduce DBusAddress as a rename of Address. #372

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,14 +125,14 @@ using Connection = Tmds.DBus.Protocol.Connection;
using NetworkManager.DBus;
using Tmds.DBus.Protocol;

string? systemBusAddress = Address.System;
string? systemBusAddress = DBusAddress.System;
if (systemBusAddress is null)
{
Console.Write("Can not determine system bus address");
return 1;
}

Connection connection = new Connection(Address.System!);
Connection connection = new Connection(DBusAddress.System!);
await connection.ConnectAsync();
Console.WriteLine("Connected to system bus.");

Expand Down
2 changes: 1 addition & 1 deletion docs/protocol.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ class Program

private async static Task<string> StartAddServiceAsync()
{
var connection = new Connection(Address.Session!);
var connection = new Connection(DBusAddress.Session!);

await connection.ConnectAsync();

Expand Down
2 changes: 1 addition & 1 deletion samples/MediaPlayer/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
using Tmds.DBus.Protocol;
using Tmds.DBus.SourceGenerator;

var connection = new Connection(Address.Session!);
var connection = new Connection(DBusAddress.Session!);
await connection.ConnectAsync();

var mediaPlayer = new DBusMediaPlayer(connection);
Expand Down
2 changes: 1 addition & 1 deletion samples/MediaPlayerRemote/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Console.WriteLine("MediaPlayerRemote Sample");

// Connect to the session bus.
using var connection = new Connection(Address.Session!);
using var connection = new Connection(DBusAddress.Session!);
await connection.ConnectAsync();

// Find all players.
Expand Down
4 changes: 2 additions & 2 deletions samples/NetworkManager/Program.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@
using Tmds.DBus.Protocol;
using System;

string? systemBusAddress = Address.System;
string? systemBusAddress = DBusAddress.System;
if (systemBusAddress is null)
{
Console.Write("Can not determine system bus address");
return 1;
}

Connection connection = new Connection(Address.System!);
Connection connection = new Connection(DBusAddress.System!);
await connection.ConnectAsync();
Console.WriteLine("Connected to system bus.");

Expand Down
217 changes: 3 additions & 214 deletions src/Tmds.DBus.Protocol/Address.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,231 +1,20 @@
using System.IO.MemoryMappedFiles;

namespace Tmds.DBus.Protocol;

/// <summary>
/// Provides D-Bus addresses for the system and session bus.
/// </summary>
[Obsolete("Use DBusAddress instead.")]
public static class Address
{
private const string LibX11 = "libX11.so.6";

private static bool _systemAddressResolved = false;
private static string? _systemAddress = null;
private static bool _sessionAddressResolved = false;
private static string? _sessionAddress = null;

/// <summary>
/// Gets the D-Bus system bus address.
/// </summary>
public static string? System
{
get
{
if (_systemAddressResolved)
{
return _systemAddress;
}

_systemAddress = Environment.GetEnvironmentVariable("DBUS_SYSTEM_BUS_ADDRESS");

if (string.IsNullOrEmpty(_systemAddress) && !PlatformDetection.IsWindows())
{
_systemAddress = "unix:path=/var/run/dbus/system_bus_socket";
}

_systemAddressResolved = true;
return _systemAddress;
}
}
=> DBusAddress.System;

/// <summary>
/// Gets the D-Bus session bus address.
/// </summary>
public static string? Session
{
get
{
if (_sessionAddressResolved)
{
return _sessionAddress;
}

_sessionAddress = Environment.GetEnvironmentVariable("DBUS_SESSION_BUS_ADDRESS");

if (string.IsNullOrEmpty(_sessionAddress))
{
if (PlatformDetection.IsWindows())
{
_sessionAddress = GetSessionBusAddressFromSharedMemory();
}
else
{
_sessionAddress = GetSessionBusAddressFromX11();
}
}

_sessionAddressResolved = true;
return _sessionAddress;
}
}

private static string? GetSessionBusAddressFromX11()
{
if (!string.IsNullOrEmpty(Environment.GetEnvironmentVariable("DISPLAY")))
{
var display = XOpenDisplay(null);
if (display == IntPtr.Zero)
{
return null;
}
string username;
unsafe
{
const int BufLen = 1024;
byte* stackBuf = stackalloc byte[BufLen];
Passwd passwd;
IntPtr result;
getpwuid_r(getuid(), out passwd, stackBuf, BufLen, out result);
if (result != IntPtr.Zero)
{
username = Marshal.PtrToStringAnsi(passwd.Name)!;
}
else
{
return null;
}
}
var machineId = DBusEnvironment.MachineId.Replace("-", string.Empty);
var selectionName = $"_DBUS_SESSION_BUS_SELECTION_{username}_{machineId}";
var selectionAtom = XInternAtom(display, selectionName, false);
if (selectionAtom == IntPtr.Zero)
{
return null;
}
var owner = XGetSelectionOwner(display, selectionAtom);
if (owner == IntPtr.Zero)
{
return null;
}
var addressAtom = XInternAtom(display, "_DBUS_SESSION_BUS_ADDRESS", false);
if (addressAtom == IntPtr.Zero)
{
return null;
}

IntPtr actualReturnType;
IntPtr actualReturnFormat;
IntPtr nrItemsReturned;
IntPtr bytesAfterReturn;
IntPtr propReturn;

int rv = XGetWindowProperty(display, owner, addressAtom, 0, 1024, false, (IntPtr)31 /* XA_STRING */,
out actualReturnType, out actualReturnFormat, out nrItemsReturned, out bytesAfterReturn, out propReturn);
string? address = rv == 0 ? Marshal.PtrToStringAnsi(propReturn) : null;
if (propReturn != IntPtr.Zero)
{
XFree(propReturn);
}

XCloseDisplay(display);

return address;
}
else
{
return null;
}
}

private static string? GetSessionBusAddressFromSharedMemory()
{
string? result = ReadSharedMemoryString("DBusDaemonAddressInfo", 255);
if (string.IsNullOrEmpty(result))
{
result = ReadSharedMemoryString("DBusDaemonAddressInfoDebug", 255);
}
return result;
}

private static string? ReadSharedMemoryString(string id, long maxlen = -1)
{
if (!PlatformDetection.IsWindows())
{
return null;
}
MemoryMappedFile? shmem;
try
{
shmem = MemoryMappedFile.OpenExisting(id);
}
catch
{
shmem = null;
}
if (shmem == null)
{
return null;
}

MemoryMappedViewStream s = shmem.CreateViewStream();
long len = s.Length;
if (maxlen >= 0 && len > maxlen)
{
len = maxlen;
}
if (len == 0)
{
return string.Empty;
}
if (len > int.MaxValue)
{
len = int.MaxValue;
}
byte[] bytes = new byte[len];
int count = s.Read(bytes, 0, (int)len);
if (count <= 0)
{
return string.Empty;
}

count = 0;
while (count < len && bytes[count] != 0)
{
count++;
}

return Encoding.UTF8.GetString(bytes, 0, count);
}

struct Passwd
{
public IntPtr Name;
public IntPtr Password;
public uint UserID;
public uint GroupID;
public IntPtr UserInfo;
public IntPtr HomeDir;
public IntPtr Shell;
}

[DllImport("libc")]
private static extern unsafe int getpwuid_r(uint uid, out Passwd pwd, byte* buf, int bufLen, out IntPtr result);
[DllImport("libc")]
private static extern uint getuid();

[DllImport(LibX11)]
private static extern IntPtr XOpenDisplay(string? name);
[DllImport(LibX11)]
private static extern int XCloseDisplay(IntPtr display);
[DllImport(LibX11)]
private static extern IntPtr XInternAtom(IntPtr display, string atom_name, bool only_if_exists);
[DllImport(LibX11)]
private static extern int XGetWindowProperty(IntPtr display, IntPtr w, IntPtr property,
int long_offset, int long_length, bool delete, IntPtr req_type,
out IntPtr actual_type_return, out IntPtr actual_format_return,
out IntPtr nitems_return, out IntPtr bytes_after_return, out IntPtr prop_return);
[DllImport(LibX11)]
private static extern int XFree(IntPtr data);
[DllImport(LibX11)]
private static extern IntPtr XGetSelectionOwner(IntPtr display, IntPtr Atom);
=> DBusAddress.Session;
}
4 changes: 2 additions & 2 deletions src/Tmds.DBus.Protocol/Connection.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,12 +23,12 @@ public partial class Connection : IDisposable
/// <summary>
/// Gets a shared connection to the system bus.
/// </summary>
public static Connection System => s_systemConnection ?? CreateConnection(ref s_systemConnection, Address.System);
public static Connection System => s_systemConnection ?? CreateConnection(ref s_systemConnection, DBusAddress.System);

/// <summary>
/// Gets a shared connection to the session bus.
/// </summary>
public static Connection Session => s_sessionConnection ?? CreateConnection(ref s_sessionConnection, Address.Session);
public static Connection Session => s_sessionConnection ?? CreateConnection(ref s_sessionConnection, DBusAddress.Session);

/// <summary>
/// Gets the unique name assigned to this connection by the bus.
Expand Down
Loading
Loading