Connection Class

Represents the logical connection between a specific Perforce Server instance and a specific client application.

Inheritance Hierarchy

SystemObject
Perforce.P4Connection

Namespace: Perforce.P4
Assembly: p4api.net (in p4api.net.dll) Version: 2023.2.258.5793

Syntax

C++

Copy

public class Connection : IDisposable

Public Class Connection
	Implements IDisposable

public ref class Connection : IDisposable

type Connection =  
    class
        interface IDisposable
    end

The Connection type exposes the following members.

Constructors

	Name	Description
	Connection	Construct a Connection given a Server

Top

Properties

	Name	Description
	ApiLevel	What API level does the server support?
	CharacterSetName	The CharacterSet to use for this connection
	Client	Property to access client object
	ClientMetadata	Property to access Client Metadata
	CommandTimeout	Obsolete.
	Credential	Property to access Credentials
	CurrentWorkingDirectory	Set CurrentWorkingDirectory for this server
	KeepAlive	Callback to allow the client/user to cancel a long running command
	KeepAliveDelay	Time for a command to run before allowing the client/user to cancel a long running command
	LastResults	The results of the last command executed
	Server	Property to access Server associated with connection
	Status	Property to access Connection Status
	UserName	Property to access User Name

Top

Methods

	Name	Description
	CancelCommand(P4Command)	Cancel a running command
	CancelCommand(UInt32)	Cancel a running command
	Connect	Connect to the server with the given options
	connectionEstablished	returns true if the connection has been made
	CreateCommand	Create a P4Command that can be run on the connection
	Disconnect	Disconnect from the server
	Disconnect(Options)	Disconnect from the server
	Dispose	Dispose of connection. Forces disconnect
	Equals	(Inherited from Object.)
	Finalize	(Inherited from Object.)
	GetActiveTicket	Returns the ticket used by the current connection
	GetExistingTicket	Get the existing ticket if any for a user on the specified server
	GetHashCode	(Inherited from Object.)
	GetMapApi	Create a P4.P4MapApi object to be used on the current server connection
	GetP4ConfigFile	The config file used by the connection (if any)
	GetP4ConfigFile(String)	The config file that will be used by a given directory (if any)
	GetP4EnvironmentVar	Get the value of an P4 environment variable
	getP4Server	Return the server connection
	GetType	(Inherited from Object.)
	IsFileIgnored	Is this file ignored based on the file specified by p4ignore (if any)
	Login(String)	Automate the Login to the Perforce Server
	Login(String, Options)	Login to the Perforce Server
	Login(String, Boolean)	Runs the login process. If the server is using ticket based authentication, actually runs the logon three times. Once to login and update the ticket file, once to get the ticket from the server and finally once to get the ticket expiration data.
	Login(String, Options, String)	Run a Login on the Perforce Server
	Logout	Logout of the Perforce server
	MemberwiseClone	(Inherited from Object.)
	ReleaseConnection	Release the connection held by the bridge to the server. This will cause the bridge to call init before the next command is run, forcing it to reinitialize any cached connection settings.
	SetClient	Set the client for this connection
	SetP4EnvironmentVar	Set the value of an P4 environment variable
	SetPassword(String, String)	Set the current user's password on the Perforce server.
	SetPassword(String, String, String)	Set the a user's password on the Perforce server.
	ToString	(Inherited from Object.)
	Trust	Run the client side command trust
	TrustAndConnect	Connect to an ssl server, handle trust handshake

Top

Events

	Name	Description
	CommandEcho	Handler for Command Echo
	ErrorReceived	Handler for Error Results
	InfoResultsReceived	Handler for Info Results
	ResponseTimeEcho	Handler for Response Time Echo
	TaggedOutputReceived	Handler for Tagged Output
	TextResultsReceived	Handler for Text Results

Top

Reference

Perforce.P4 Namespace