P4Server Class

P4Server Represents the connection to a Perforce Server using the the P4 Bridge DLL. It wraps the calls exported by the DLL and transforms the data types exported by the DLL as native C#.NET data types.

Inheritance Hierarchy

SystemObject
Perforce.P4P4Server

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

Syntax

C++

Copy

public class P4Server : IDisposable

Public Class P4Server
	Implements IDisposable

public ref class P4Server : IDisposable

type P4Server =  
    class
        interface IDisposable
    end

The P4Server type exposes the following members.

Constructors

	Name	Description
	P4Server(String)	Create a P4BridgeServer using the PUC specified by the environment or a p4config file if one exists.
	P4Server(String, String, String, String)	Create a P4BridgeServer used to connect to the specified P4Server
	P4Server(String, String, String, String, String, String, String)	Create a P4BridgeServer used to connect to the specified P4Server

Top

Properties

	Name	Description
	ApiLevel	What API level does the server support
	CharacterSet	The character set used by the connection
	Client	The client workspace used by the connection
	Config	The config file used by the connection
	ConnectionError	Get the error message generated by the previous connection (if any) from the bridge dll.
	ConnectionErrorInt	Get the error message generated by the previous connection (if any)
	CurrentWorkingDirectory	The current working directory (cwd) used by the p4 server
	KeepAlive
	LastResults	The results of the last command executed on this thread
	Password	The user's password used by the connection
	Port	The hostname:port used by the connection
	ProgramName	The program name used by the connection
	ProgramVersion	The program version used by the connection
	RequiresLogin	The server requires a client to use the login command to pass credentials.
	RunCmdTimout	Obsolete.
	User	The user name used by the connection
	UseUnicode	Need to use Unicode when marshalling to/from the P4 server
	Version	Get the version of the p4.net assembly

Top

Methods

	Name	Description
	CancelCommand	Cancel a running command
	Close	Close the connection to a P4 Server
	ConnectionInfoFromPath
	ContinueRunCmdTimer
	Disconnect
	Dispose	For IDispose
	Dispose(Boolean)	Releases the unmanaged resources used by the P4Server and optionally releases the managed resources
	EchoCommand(String)	Broadcast a string on the CommandEcho event
	EchoCommand(String, StringList)	Broadcast a the command line (cmd and args) on the CommandEcho event
	EchoResponseTime	Broadcast a the command line (cmd, args and response time) on the ResponseTimeEcho event
	Equals	(Inherited from Object.)
	Finalize	Finalizer (Overrides ObjectFinalize.)
	Get	Get an environment setting used by the server, such as user, client, ..
	GetBinaryResults	Get the complete binary results for the last command
	getCmdId
	GetConfig	The config file that will be used by a given directory
	GetDataSet
	GetEnvironmentTicketFile	Use the C++ API to determine the path of the ticket file set in the environment
	GetErrorResults	Get a list of errors (if any) generated by a command
	GetHashCode	(Inherited from Object.)
	GetInfoResults	Get the information messages generated by the previous command
	GetParallelOperationCount	Mostly for testing, provide a way to tell if a parallel operation has started
	GetTaggedOutput	Get the tagged output generated by a command
	GetTextResults	Get the complete text results for the last command
	GetTicket(String, String)	Use the C++ API to find an existing ticket if a file will be ignored
	GetTicket(String, String, String)	Use the C++ API to get the ticket
	GetTicketFile	Use the C++ API to determine the path of the ticket file for the current connection
	GetTicketFileCredential	Use the C++ API to find an existing ticket if a file will be ignored
	GetType	(Inherited from Object.)
	IsCommandPaused
	IsConnected
	IsIgnored	Use the C++ API to determine if a file will be ignored
	Login	Run a login command on the server
	Logout	Run a logout command on the server
	MemberwiseClone	(Inherited from Object.)
	PauseRunCmdTimer
	Reconnect	Reconnect to the server in the event the connection is lost
	RunCommand	Run a P4 command on the P4 Server
	Set	Set an environment setting used by the server, such as user, client, ..
	SetConnectionData	The parameters used by the connection
	SetDataSet	The data set for use by a command
	SetDebugLevel(String)	Set client debug level for things like "rpc=3" Output goes to stdout
	SetDebugLevel(String, String)	Set client debug level for things like "rpc=3" Output goes to specified log file
	SetProtocol
	SetThreadOwner
	SetTicketFile	Use the C++ API to set the path of the ticket file
	ToString	(Inherited from Object.)
	Update	Update an environment setting used by the server, such as user, client, .. Makes a local only change which overrides registry, environment etc... And does not get written into the registry or the environment use "null" value to remove an existing Update setting.
	UrlHandled

Top

Events

	Name	Description
	BinaryResultsReceived	Broadcast event for binary data
	CommandEcho	Broadcast event for text results
	ErrorReceived	Broadcast errors received
	InfoResultsReceived	Broadcast event for info results
	ResponseTimeEcho	Broadcast event for text results
	TaggedOutputReceived	Event to broadcast tagged output
	TextResultsReceived	Broadcast event for text results

Top

Fields

	Name	Description
	IdleDisconnectWaitTime
	KeepAliveDelay	Time for a command to run before allowing the client/user to cancel;
	PromptHandler	Delegate used to process prompts for input from the server.
	ResolveAHandler	Delegate used to provide a custom handler for Resolve callbacks passing a ClientResolve object from the p4api.
	ResolveHandler	Delegate used to provide a custom handler for Resolve callbacks passing a ClientMerge object from the p4api.
	RunCmdTimeout

Top

Remarks

This file contains the internal data a methods that are not part of the public interface

Reference

Perforce.P4 Namespace